ui_m6561.h

#pragma once
/*#
    # ui_m6561.h

    Debug visualization for m6561.h (VIC-I)

    Do this:
    ~~~C
    #define CHIPS_UI_IMPL
    ~~~
    before you include this file in *one* C++ file to create the
    implementation.

    Optionally provide the following macros with your own implementation

    ~~~C
    CHIPS_ASSERT(c)
    ~~~
        your own assert macro (default: assert(c))

    Include the following headers before the including the *declaration*:
        - m6561.h
        - ui_chip.h
        - ui_settings.h

    Include the following headers before including the *implementation*:
        - imgui.h
        - m6561.h
        - ui_util.h
        - ui_chip.h

    All strings provided to ui_m6561_init() must remain alive until
    ui_m6561_discard() is called!

    ## zlib/libpng license

    Copyright (c) 2019 Andre Weissflog
    This software is provided 'as-is', without any express or implied warranty.
    In no event will the authors be held liable for any damages arising from the
    use of this software.
    Permission is granted to anyone to use this software for any purpose,
    including commercial applications, and to alter it and redistribute it
    freely, subject to the following restrictions:
        1. The origin of this software must not be misrepresented; you must not
        claim that you wrote the original software. If you use this software in a
        product, an acknowledgment in the product documentation would be
        appreciated but is not required.
        2. Altered source versions must be plainly marked as such, and must not
        be misrepresented as being the original software.
        3. This notice may not be removed or altered from any source
        distribution.
#*/
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* setup parameters for ui_m6561_init()
    NOTE: all string data must remain alive until ui_m6561_discard()!
*/
typedef struct ui_m6561_desc_t {
    const char* title;          /* window title */
    m6561_t* vic;               /* pointer to m6561_t instance to track */
    uint16_t regs_base;         /* register bank base address (e.g. 0x9000 in VIC-20) */
    int x, y;                   /* initial window pos */
    int w, h;                   /* initial window size (default size if 0) */
    bool open;                  /* initial open state */
    ui_chip_desc_t chip_desc;   /* chip visualization desc */
} ui_m6561_desc_t;

typedef struct ui_m6561_t {
    const char* title;
    m6561_t* vic;
    uint16_t regs_base;
    float init_x, init_y;
    float init_w, init_h;
    bool open;
    bool last_open;
    bool valid;
    ui_chip_t chip;
} ui_m6561_t;

void ui_m6561_init(ui_m6561_t* win, const ui_m6561_desc_t* desc);
void ui_m6561_discard(ui_m6561_t* win);
void ui_m6561_draw(ui_m6561_t* win);
void ui_m6561_save_settings(ui_m6561_t* win, ui_settings_t* settings);
void ui_m6561_load_settings(ui_m6561_t* win, const ui_settings_t* settings);

#ifdef __cplusplus
} /* extern "C" */
#endif

/*-- IMPLEMENTATION (include in C++ source) ----------------------------------*/
#ifdef CHIPS_UI_IMPL
#ifndef __cplusplus
#error "implementation must be compiled as C++"
#endif
#include <string.h> /* memset */
#ifndef CHIPS_ASSERT
    #include <assert.h>
    #define CHIPS_ASSERT(c) assert(c)
#endif

void ui_m6561_init(ui_m6561_t* win, const ui_m6561_desc_t* desc) {
    CHIPS_ASSERT(win && desc);
    CHIPS_ASSERT(desc->title);
    CHIPS_ASSERT(desc->vic);
    memset(win, 0, sizeof(ui_m6561_t));
    win->title = desc->title;
    win->vic = desc->vic;
    win->regs_base = desc->regs_base;
    win->init_x = (float) desc->x;
    win->init_y = (float) desc->y;
    win->init_w = (float) ((desc->w == 0) ? 440 : desc->w);
    win->init_h = (float) ((desc->h == 0) ? 416 : desc->h);
    win->open = win->last_open = desc->open;
    win->valid = true;
    ui_chip_init(&win->chip, &desc->chip_desc);
}

void ui_m6561_discard(ui_m6561_t* win) {
    CHIPS_ASSERT(win && win->valid);
    win->valid = false;
}

static void _ui_m6561_draw_hwcolors(void) {
    if (ImGui::CollapsingHeader("Hardware Colors", ImGuiTreeNodeFlags_DefaultOpen)) {
        ImVec4 c;
        const ImVec2 size(18,18);
        for (int i = 0; i < 16; i++) {
            c = ImColor(m6561_color(i));
            ImGui::PushID(i);
            ImGui::ColorButton("##hw_color", c, ImGuiColorEditFlags_NoAlpha, size);
            ImGui::PopID();
            if (((i+1) % 8) != 0) {
                ImGui::SameLine();
            }
        }
    }
}

static void _ui_m6561_draw_registers(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Registers", ImGuiTreeNodeFlags_DefaultOpen)) {
        for (int i = 0; i < M6561_NUM_REGS; i++) {
            ImGui::Text("CR%X ($%04X/%5d): %02X", i, win->regs_base+i, win->regs_base+i, win->vic->regs[i]);
        }
    }
}

static void _ui_m6561_draw_raster_unit(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Raster Unit", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_raster_unit_t* rs = &win->vic->rs;
        ImGui::Text("h_count: %02X", rs->h_count);
        ImGui::Text("v_count: %03X", rs->v_count);
        ImGui::Text("vc:          %03X", rs->vc);
        ImGui::Text("vc_base:     %03X", rs->vc_base);
        ImGui::Text("vc_disabled: %d", rs->vc_disabled);
        ImGui::Text("rc:          %d", rs->rc);
        ImGui::Text("row_height:  %d", rs->row_height);
        ImGui::Text("row_count:   %02X", rs->row_count);
    }
}

static void _ui_m6561_draw_memory_unit(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Memory Unit", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_memory_unit_t* mem = &win->vic->mem;
        ImGui::Text("c_addr_base: %04X", mem->c_addr_base);
        ImGui::Text("g_addr_base: %04X", mem->g_addr_base);
        ImGui::Text("c_value: %03X", mem->c_value);
    }
}

static void _ui_m6561_draw_rgb(const char* label, uint32_t val) {
    ImGui::Text("%s", label); ImGui::SameLine();
    ImGui::ColorButton("##rgbclr", ImColor(val | 0xFF000000), ImGuiColorEditFlags_NoAlpha, ImVec2(12,12));
}

static void _ui_m6561_draw_graphics_unit(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Graphics Unit", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_graphics_unit_t* gu = &win->vic->gunit;
        ImGui::Text("shifter: %02X", gu->shift);
        ImGui::Text("color:   %02X", gu->color);
        _ui_m6561_draw_rgb("bg_color:", m6561_color(gu->bg_color));
        _ui_m6561_draw_rgb("brd_color", m6561_color(gu->brd_color));
        _ui_m6561_draw_rgb("aux_color", m6561_color(gu->aux_color));
    }
}

static void _ui_m6561_draw_border_unit(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Border Unit", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_border_unit_t* b = &win->vic->border;
        ImGui::Text("left:   %02X", b->left);
        ImGui::Text("right:  %02X", b->right);
        ImGui::Text("top:    %02X", b->top);
        ImGui::Text("bottom: %02X", b->bottom);
        ImGui::Text("enabled: %d", b->enabled);
    }
}

static void _ui_m6561_draw_crt(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("CRT", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_crt_t* crt = &win->vic->crt;
        ImGui::Text("x: %3d  y: %3d", crt->x, crt->y);
        ImGui::Text("vis x: %d=>%d", crt->vis_x0, crt->vis_x1);
        ImGui::Text("vis y: %d=>%d", crt->vis_y0, crt->vis_y1);
    }
}

static void _ui_m6561_draw_sound(const ui_m6561_t* win) {
    if (ImGui::CollapsingHeader("Sound Unit", ImGuiTreeNodeFlags_DefaultOpen)) {
        const m6561_sound_t* snd = &win->vic->sound;
        ImGui::Text("Volume: %02X", snd->volume);
        ImGui::Separator();
        for (int i = 0; i < 3; i++) {
            const m6561_voice_t* v = &snd->voice[i];
            ImGui::Text("Voice %d:", i);
            ImGui::Text("  Enabled: %s", v->enabled ? "YES":"NO");
            ImGui::Text("  Count:   %04X", v->count);
            ImGui::Text("  Period:  %04X", v->period);
            ImGui::Text("  Bit:     %s", v->bit ? "ON":"OFF");
            ImGui::Separator();
        }
        const m6561_noise_t* n = &snd->noise;
        ImGui::Text("Noise:");
        ImGui::Text("  Enabled: %s", n->enabled ? "YES":"NO");
        ImGui::Text("  Count:   %04X", n->count);
        ImGui::Text("  Period:  %04X", n->period);
        ImGui::Text("  Bit:     %s", n->bit ? "ON":"OFF");
        ui_util_b24("  Shift:   ", n->shift);
        ImGui::Separator();
        ImGui::Text("Sample Output");
        ImGui::Text("  Count:   %04X", snd->sample_counter);
        ImGui::Text("  Period:  %04X", snd->sample_period);
        ImGui::Text("  Volume:  %.4f", snd->sample_mag);
        ImGui::Text("  Sample:  %.4f", snd->sample);
    }
}

void ui_m6561_draw(ui_m6561_t* win) {
    CHIPS_ASSERT(win && win->valid);
    ui_util_handle_window_open_dirty(&win->open, &win->last_open);
    if (!win->open) {
        return;
    }
    ImGui::SetNextWindowPos(ImVec2(win->init_x, win->init_y), ImGuiCond_FirstUseEver);
    ImGui::SetNextWindowSize(ImVec2(win->init_w, win->init_h), ImGuiCond_FirstUseEver);
    if (ImGui::Begin(win->title, &win->open)) {
        ImGui::BeginChild("##m6561_chip", ImVec2(176, 0), true);
        ui_chip_draw(&win->chip, win->vic->pins);
        ImGui::EndChild();
        ImGui::SameLine();
        ImGui::BeginChild("##m6561_state", ImVec2(0, 0), true);
        ImGui::Checkbox("Debug Visualization", &win->vic->debug_vis);
        _ui_m6561_draw_hwcolors();
        _ui_m6561_draw_registers(win);
        _ui_m6561_draw_raster_unit(win);
        _ui_m6561_draw_memory_unit(win);
        _ui_m6561_draw_graphics_unit(win);
        _ui_m6561_draw_border_unit(win);
        _ui_m6561_draw_crt(win);
        _ui_m6561_draw_sound(win);
        ImGui::EndChild();
    }
    ImGui::End();
}

void ui_m6561_save_settings(ui_m6561_t* win, ui_settings_t* settings) {
    CHIPS_ASSERT(win && settings);
    ui_settings_add(settings, win->title, win->open);
}

void ui_m6561_load_settings(ui_m6561_t* win, const ui_settings_t* settings) {
    CHIPS_ASSERT(win && settings);
    win->open = ui_settings_isopen(settings, win->title);
}

#endif /* CHIPS_UI_IMPL */