Add POC GB Emulator

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Esteban Fuentealba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,10 @@
+# [MALVEKE] ***GAME BOY*** Emulator (POC)
+
+## Introduction
+
+
+<p align='center'>
+<br />
+<br />
+From Talcahuano 🇨🇱 with ❤ 
+</p>

application.fam

@@ -0,0 +1,17 @@
+App(
+    appid="malveke_gb_emulator",
+    name="[MALVEKE] Emulator",
+    apptype=FlipperAppType.EXTERNAL,
+    entry_point="malveke_gb_emulator_app",
+    cdefines=["APP_EMULATOR"],
+    requires=["gui"],
+    stack_size=1*1024,
+    order=1,
+    fap_libs=["assets"],
+	fap_icon="icons/icon.png",
+    fap_icon_assets="icons",
+    fap_category="GPIO",
+	fap_description="GAME BOY Emulator (POC).",
+	fap_author="Esteban Fuentealba",
+	fap_weburl="https://github.com/EstebanFuentealba/MALVEKE-Flipper-Zero/"
+)

malveke_gb_emulator.c

@@ -0,0 +1,252 @@
+#include "malveke_gb_emulator.h"
+#include <malveke_gb_emulator_icons.h>
+
+
+
+static void malveke_gb_emulator_view_draw_callback(Canvas* canvas, void* _model) {
+    UartDumpModel* model = _model;
+
+    // Prepare canvas
+    canvas_set_color(canvas, ColorBlack);
+    canvas_draw_frame(canvas, 0, 0, FRAME_WIDTH, FRAME_HEIGTH);
+    
+    for(size_t p = 0; p < FRAME_BUFFER_LENGTH; ++p) {
+        uint8_t x = p % ROW_BUFFER_LENGTH; // 0 .. 15
+        uint8_t y = p / ROW_BUFFER_LENGTH; // 0 .. 63
+
+        for(uint8_t i = 0; i < 8; ++i) {
+            if((model->pixels[p] & (1 << (7 - i))) != 0) {
+                canvas_draw_dot(canvas, (x * 8) + i, y);
+            }
+        }
+    }
+
+    if (!model->initialized){
+        canvas_draw_icon(canvas, 60, 7, &I_malveke_67x49);
+        canvas_set_font(canvas, FontSecondary);
+
+        canvas_draw_str(canvas, 4, 25, "Connect");
+        canvas_set_font(canvas, FontPrimary);
+        canvas_draw_str(canvas, 4, 35, "MALVEKE");
+        canvas_set_font(canvas, FontSecondary);
+        canvas_draw_str(canvas, 4, 44, "into Flipper");
+        elements_button_center(canvas, "Ok"); 
+        // canvas_set_font(canvas, FontPrimary);
+        // canvas_draw_str(canvas, 8, 28, "GAME BOY");
+        // canvas_draw_icon(canvas, 76, 8, &I_gbcam_48x49);
+        // canvas_set_font(canvas, FontSecondary);
+        // canvas_draw_str(canvas, 8, 18, "WAITING");
+        // canvas_set_font(canvas, FontPrimary);
+        // canvas_draw_str(canvas, 8, 38, "CAMERA...");
+        // canvas_set_font(canvas, FontSecondary);
+        // canvas_draw_str(canvas, 9, 47, "Insert Cartridge");
+        // elements_button_center(canvas, "Ok"); 
+    }
+}
+
+
+static bool malveke_gb_emulator_view_input_callback(InputEvent* event, void* context) {
+    UartEchoApp* instance = context;
+    UNUSED(instance);
+    if (event->type == InputTypePress){
+        if (event->key == InputKeyUp){
+            const char gblivecamera_command_enable_dithering[] = "U\n";
+            furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)gblivecamera_command_enable_dithering, strlen(gblivecamera_command_enable_dithering));
+        }
+        else if (event->key == InputKeyDown){
+            const char gblivecamera_command_disable_dithering[] = "D\n";
+            furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)gblivecamera_command_disable_dithering, strlen(gblivecamera_command_disable_dithering));
+        }
+        else if (event->key == InputKeyRight){
+            const char gblivecamera_command_increase_exposure[] = ">\n";
+            furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)gblivecamera_command_increase_exposure, strlen(gblivecamera_command_increase_exposure));
+        }
+        else if (event->key == InputKeyLeft){
+            const char gblivecamera_command_decrease_exposure[] = "<\n";
+            furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)gblivecamera_command_decrease_exposure, strlen(gblivecamera_command_decrease_exposure));
+        }
+        else if (event->key == InputKeyOk){
+           const char gblivecamera_command[] = "S\n";
+            furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)gblivecamera_command, strlen(gblivecamera_command));    
+        }
+    }
+    return false;
+}
+
+static uint32_t malveke_gb_emulator_exit(void* context) {
+    UNUSED(context);
+    const char stop_command[] = "stopgblivecamera\n";
+    furi_hal_uart_tx(FuriHalUartIdUSART1, (uint8_t*)stop_command, strlen(stop_command));
+    return VIEW_NONE;
+}
+
+static void malveke_gb_emulator_on_irq_cb(UartIrqEvent ev, uint8_t data, void* context) {
+    furi_assert(context);
+    UartEchoApp* app = context;
+
+    if(ev == UartIrqEventRXNE) {
+        furi_stream_buffer_send(app->rx_stream, &data, 1, 0);
+        furi_thread_flags_set(furi_thread_get_id(app->worker_thread), WorkerEventRx);
+    }
+}
+
+static void process_ringbuffer(UartDumpModel* model, uint8_t byte) {
+
+    //// 1. Phase: filling the ringbuffer
+    if (model->ringbuffer_index == 0 && byte != 'Y'){ // First char has to be 'Y' in the buffer.
+        return;
+    }
+    
+    if (model->ringbuffer_index == 1 && byte != ':'){ // Second char has to be ':' in the buffer or reset.
+        model->ringbuffer_index = 0;
+        process_ringbuffer(model, byte);
+        return;
+    }
+
+    model->row_ringbuffer[model->ringbuffer_index] = byte; // Assign current byte to the ringbuffer;
+    ++model->ringbuffer_index; // Increment the ringbuffer index
+
+    if (model->ringbuffer_index < RING_BUFFER_LENGTH){ // Let's wait 'till the buffer fills.
+        return;
+    }
+
+    //// 2. Phase: flushing the ringbuffer to the framebuffer
+    model->ringbuffer_index = 0; // Let's reset the ringbuffer
+    model->initialized = true; // We've successfully established the connection
+    size_t row_start_index = model->row_ringbuffer[2] * ROW_BUFFER_LENGTH; // Third char will determine the row number
+
+    if (row_start_index > LAST_ROW_INDEX){ // Failsafe
+        row_start_index = 0;
+    }
+
+    for (size_t i = 0; i < ROW_BUFFER_LENGTH; ++i) {
+        model->pixels[row_start_index + i] = model->row_ringbuffer[i+3]; // Writing the remaining 16 bytes into the frame buffer
+    }
+}
+
+static int32_t malveke_gb_emulator_worker(void* context) {
+    furi_assert(context);
+    UartEchoApp* app = context;
+
+    while(1) {
+        uint32_t events =
+            furi_thread_flags_wait(WORKER_EVENTS_MASK, FuriFlagWaitAny, FuriWaitForever);
+        furi_check((events & FuriFlagError) == 0);
+
+        if(events & WorkerEventStop) break;
+        if(events & WorkerEventRx) {
+            size_t length = 0;
+            do {
+                size_t intended_data_size = 64;
+                uint8_t data[intended_data_size];
+                length = furi_stream_buffer_receive(app->rx_stream, data, intended_data_size, 0);
+
+                if(length > 0) {
+                    with_view_model(
+                        app->view,
+                        UartDumpModel * model, {
+                            for(size_t i = 0; i < length; i++) {
+                                process_ringbuffer(model, data[i]);
+                            }
+                        },
+                        false);
+                }
+            } while(length > 0);
+
+            notification_message(app->notification, &sequence_notification);
+            with_view_model(app->view, UartDumpModel * model, { UNUSED(model); }, true);
+        }
+    }
+
+    return 0;
+}
+
+static UartEchoApp* malveke_gb_emulator_app_alloc() {
+    UartEchoApp* app = malloc(sizeof(UartEchoApp));
+
+    app->rx_stream = furi_stream_buffer_alloc(2048, 1);
+
+    // Gui
+    app->gui = furi_record_open(RECORD_GUI);
+    app->notification = furi_record_open(RECORD_NOTIFICATION);
+
+    // View dispatcher
+    app->view_dispatcher = view_dispatcher_alloc();
+    view_dispatcher_enable_queue(app->view_dispatcher);
+    view_dispatcher_attach_to_gui(app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen);
+
+    // Views
+    app->view = view_alloc();
+    view_set_context(app->view, app);
+    view_set_draw_callback(app->view, malveke_gb_emulator_view_draw_callback);
+    view_set_input_callback(app->view, malveke_gb_emulator_view_input_callback);
+    view_allocate_model(app->view, ViewModelTypeLocking, sizeof(UartDumpModel));
+
+    with_view_model(
+        app->view,
+        UartDumpModel * model,
+        {
+            for(size_t i = 0; i < FRAME_BUFFER_LENGTH; i++) {
+                model->pixels[i] = 0;
+            }
+        },
+        true);
+
+    view_set_previous_callback(app->view, malveke_gb_emulator_exit);
+    view_dispatcher_add_view(app->view_dispatcher, 0, app->view);
+    view_dispatcher_switch_to_view(app->view_dispatcher, 0);
+
+    app->worker_thread = furi_thread_alloc_ex("UsbUartWorker", 2048, malveke_gb_emulator_worker, app);
+    furi_thread_start(app->worker_thread);
+
+    // Enable uart listener (UART & UART1)
+    // furi_hal_console_disable();
+    furi_hal_uart_set_br(FuriHalUartIdUSART1, 115200);
+    furi_hal_uart_init(FuriHalUartIdLPUART1, 250000);
+    furi_hal_uart_set_br(FuriHalUartIdLPUART1, 250000);
+    furi_hal_uart_set_irq_cb(FuriHalUartIdLPUART1, malveke_gb_emulator_on_irq_cb, app);
+    // furi_hal_uart_set_irq_cb(FuriHalUartIdUSART1, malveke_gb_emulator_on_irq_cb, app);
+    furi_hal_power_enable_otg();
+    furi_delay_ms(1); 
+    return app;
+}
+
+static void malveke_gb_emulator_app_free(UartEchoApp* app) {
+    furi_assert(app);
+
+    furi_thread_flags_set(furi_thread_get_id(app->worker_thread), WorkerEventStop);
+    furi_thread_join(app->worker_thread);
+    furi_thread_free(app->worker_thread);
+
+    // furi_hal_uart_set_irq_cb(FuriHalUartIdUSART1, NULL, NULL);
+    furi_hal_uart_set_irq_cb(FuriHalUartIdLPUART1, NULL, NULL);
+    furi_hal_uart_deinit(FuriHalUartIdLPUART1);
+
+    // Free views
+    view_dispatcher_remove_view(app->view_dispatcher, 0);
+
+    view_free(app->view);
+    view_dispatcher_free(app->view_dispatcher);
+
+    // Close gui record
+    furi_record_close(RECORD_GUI);
+    furi_record_close(RECORD_NOTIFICATION);
+    app->gui = NULL;
+
+    furi_stream_buffer_free(app->rx_stream);
+
+    // Free rest
+    free(app);
+}
+
+int32_t malveke_gb_emulator_app(void* p) {
+    UNUSED(p);
+
+    UartEchoApp* app = malveke_gb_emulator_app_alloc();
+    view_dispatcher_run(app->view_dispatcher);
+    malveke_gb_emulator_app_free(app);
+    
+    furi_hal_power_disable_otg();
+
+    return 0;
+}

malveke_gb_emulator.h

@@ -0,0 +1,83 @@
+// TODO
+// (DONE) Fix performance when not being charged
+// (DONE) Add UART command parsing to Esp32
+// (DONE) Prepare application and icon on github
+// (DONE) Write snapshots to SD card
+// 5. Set a constant refresh rate to the Flipper's display
+// 6. Emulate grayscale
+// 7. Photo browser app
+
+#include <furi.h>
+#include <furi_hal.h>
+#include <gui/gui.h>
+#include <gui/icon_i.h>
+#include <notification/notification.h>
+#include <notification/notification_messages.h>
+#include <gui/elements.h>
+#include <furi_hal_uart.h>
+#include <furi_hal_console.h>
+#include <gui/view_dispatcher.h>
+#include <gui/modules/dialog_ex.h>
+#include <storage/filesystem_api_defines.h>
+#include <storage/storage.h>
+
+#define THREAD_ALLOC 2048
+
+#define FRAME_WIDTH 128
+#define FRAME_HEIGTH 64
+#define FRAME_BIT_DEPTH 1
+#define FRAME_BUFFER_LENGTH (FRAME_WIDTH * FRAME_HEIGTH * FRAME_BIT_DEPTH / 8) // 128*64*1 / 8 = 1024
+#define ROW_BUFFER_LENGTH (FRAME_WIDTH / 8) // 128/8 = 16
+#define LAST_ROW_INDEX (FRAME_BUFFER_LENGTH - ROW_BUFFER_LENGTH) // 1024 - 16 = 1008
+#define RING_BUFFER_LENGTH (ROW_BUFFER_LENGTH + 3) // ROW_BUFFER_LENGTH + Header => 16 + 3 = 19
+#define BITMAP_HEADER_LENGTH 62
+#define IMAGE_FILE_DIRECTORY_PATH EXT_PATH("DCIM")
+
+static const unsigned char bitmap_header[BITMAP_HEADER_LENGTH] = {
+	0x42, 0x4D, 0x3E, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3E, 0x00,
+	0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x40, 0x00,
+	0x00, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF,
+	0xFF, 0x00
+};
+
+const uint8_t _I_DolphinCommon_56x48_0[] = {0x01,0x00,0xdf,0x00,0x00,0x1f,0xfe,0x0e,0x05,0x3f,0x04,0x06,0x78,0x06,0x30,0x20,0xf8,0x00,0xc6,0x12,0x1c,0x04,0x0c,0x0a,0x38,0x08,0x08,0x0c,0x60,0xc0,0x21,0xe0,0x04,0x0a,0x18,0x02,0x1b,0x00,0x18,0xa3,0x00,0x21,0x90,0x01,0x8a,0x20,0x02,0x19,0x80,0x18,0x80,0x64,0x09,0x20,0x89,0x81,0x8c,0x3e,0x41,0xe2,0x80,0x50,0x00,0x43,0x08,0x01,0x0c,0xfc,0x68,0x40,0x61,0xc0,0x50,0x30,0x00,0x63,0xa0,0x7f,0x80,0xc4,0x41,0x19,0x07,0xff,0x02,0x06,0x18,0x24,0x03,0x41,0xf3,0x2b,0x10,0x19,0x38,0x10,0x30,0x31,0x7f,0xe0,0x34,0x08,0x30,0x19,0x60,0x80,0x65,0x86,0x0a,0x4c,0x0c,0x30,0x81,0xb9,0x41,0xa0,0x54,0x08,0xc7,0xe2,0x06,0x8a,0x18,0x25,0x02,0x21,0x0f,0x19,0x88,0xd8,0x6e,0x1b,0x01,0xd1,0x1b,0x86,0x39,0x66,0x3a,0xa4,0x1a,0x50,0x06,0x48,0x18,0x18,0xd0,0x03,0x01,0x41,0x98,0xcc,0x60,0x39,0x01,0x49,0x2d,0x06,0x03,0x50,0xf8,0x40,0x3e,0x02,0xc1,0x82,0x86,0xc7,0xfe,0x0f,0x28,0x2c,0x91,0xd2,0x90,0x9a,0x18,0x19,0x3e,0x6d,0x73,0x12,0x16,0x00,0x32,0x49,0x72,0xc0,0x7e,0x5d,0x44,0xba,0x2c,0x08,0xa4,0xc8,0x82,0x06,0x17,0xe0,0x81,0x90,0x2a,0x40,0x61,0xe1,0xa2,0x44,0x0c,0x76,0x2b,0xe8,0x89,0x26,0x43,0x83,0x31,0x8c,0x78,0x0c,0xb0,0x48,0x10,0x1a,0xe0,0x00,0x63,};
+const uint8_t* const _I_DolphinCommon_56x48[] = {_I_DolphinCommon_56x48_0};
+const Icon I_DolphinCommon_56x48 = {.width=56,.height=48,.frame_count=1,.frame_rate=0,.frames=_I_DolphinCommon_56x48};
+
+typedef struct UartDumpModel UartDumpModel;
+
+typedef struct {
+    Gui* gui;
+    Storage* storage;
+    NotificationApp* notification;
+    ViewDispatcher* view_dispatcher;
+    View* view;
+    FuriThread* worker_thread;
+    FuriStreamBuffer* rx_stream;
+} UartEchoApp;
+
+struct UartDumpModel {
+    uint8_t pixels[FRAME_BUFFER_LENGTH];
+
+    File* cameraSav;
+    bool initialized;
+    int page;
+    uint8_t row_ringbuffer[RING_BUFFER_LENGTH];
+    uint8_t ringbuffer_index;
+};
+
+typedef enum {
+    WorkerEventReserved = (1 << 0), // Reserved for StreamBuffer internal event
+    WorkerEventStop = (1 << 1),
+    WorkerEventRx = (1 << 2),
+} WorkerEventFlags;
+
+#define WORKER_EVENTS_MASK (WorkerEventStop | WorkerEventRx)
+
+const NotificationSequence sequence_notification = {
+    &message_display_backlight_on,
+    &message_delay_10,
+    NULL,
+};