# ishaannene/convo-boost architecture

> Architecture diagram of the GitHub repository ishaannene/convo-boost, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ishaannene/convo-boost
- Repository: https://github.com/ishaannene/convo-boost

## Overview

##### Project Type & Purpose
- A macOS command‑line toolkit demonstrating GPU‑accelerated image processing via Apple’s Metal.
- Four standalone utilities: Random Image Generator, Image Effects Processor, Metal Convolution, PPM→PNG Converter.

##### Main Components
- CLI Frontends (four binaries)
- Core Processing Modules
– CPU-based image I/O & effects (C++17 using stb_image/​write)
– GPU-based shaders (Metal kernels in `.metal`/Objective‑C++ `.mm`)
- File I/O
– PPM input/output
– Optional PNG output via stb_image_write or converter utility
- Build & Config
– CMakeLists.txt, build scripts, test scripts

##### Component Interactions
[User]
↓
CLI Tool (e.g., image_effects_processor)
↙            ↘
CPU Parser    GPU Kernels
↘            ↙
Image Buffers
↓
File Output (PPM/PNG)

##### Architectural Patterns
- Modular CLI → each tool is a separate executable.
- Dual‑path processing: CPU fallback vs Metal pipeline.
- Shared libraries: stb_image for uniform I/O.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User input
    User["User"] 

    %% CLI Tools
    subgraph "CLI Tools"
        RIG["Random Image Generator"]:::cpu
        EFP["Image Effects Processor"]:::cpu
        MC["Metal Convolution"]:::cpu
        P2P["PPM→PNG Converter"]:::cpu
    end

    %% Processing Modules
    subgraph "Core Processing Modules"
        CPU["CPU Image I/O & Effects\n(stb_image)"]:::cpu
        GPU["GPU Shaders & Kernels"]:::gpu
    end

    %% File I/O
    subgraph "File I/O" 
        PPM["PPM Input/Output"]:::io
        PNG["PNG Output"]:::io
    end

    %% Build & Config
    subgraph "Build & Configuration"
        CMake["CMakeLists.txt"]:::build
        BuildScript["build.sh"]:::build
        TestScript["test.sh"]:::build
        GitIgnore[".gitignore"]:::build
        Docs["README.md / LICENSE"]:::build
    end

    %% Connections
    User -->|runs| RIG
    User -->|runs| EFP
    User -->|runs| MC
    User -->|runs| P2P

    RIG -->|uses| CPU
    EFP -->|uses| CPU
    EFP -->|invokes| GPU
    MC -->|benchmarks| CPU
    MC -->|uses| GPU
    P2P -->|reads| PPM
    P2P -->|writes| PNG

    CPU -->|loads/writes| PPM
    CPU -->|writes| PNG
    GPU -->|processes buffers| CPU

    CMake -->|builds| RIG
    CMake -->|builds| EFP
    CMake -->|builds| MC
    CMake -->|builds| P2P
    BuildScript -->|calls| CMake
    TestScript -->|tests| RIG
    TestScript -->|tests| EFP
    TestScript -->|tests| MC
    TestScript -->|tests| P2P

    %% Click Events
    click RIG "https://github.com/ishaannene/convo-boost/blob/main/random_image_generator.cpp"
    click EFP "https://github.com/ishaannene/convo-boost/blob/main/image_effects_processor.cpp"
    click EFP "https://github.com/ishaannene/convo-boost/blob/main/image_effects_processor.mm"
    click MC "https://github.com/ishaannene/convo-boost/blob/main/metal_convolution.cpp"
    click MC "https://github.com/ishaannene/convo-boost/blob/main/metal_convolution.mm"
    click P2P "https://github.com/ishaannene/convo-boost/blob/main/ppm_to_png.cpp"
    click CPU "https://github.com/ishaannene/convo-boost/blob/main/stb_image.h"
    click CPU "https://github.com/ishaannene/convo-boost/blob/main/stb_image_write.h"
    click GPU "https://github.com/ishaannene/convo-boost/blob/main/kernels.c"
    click CMake "https://github.com/ishaannene/convo-boost/blob/main/CMakeLists.txt"
    click BuildScript "https://github.com/ishaannene/convo-boost/blob/main/build.sh"
    click TestScript "https://github.com/ishaannene/convo-boost/blob/main/test.sh"
    click Docs "https://github.com/ishaannene/convo-boost/blob/main/README.md"
    click Docs "https://github.com/ishaannene/convo-boost/tree/main/LICENSE"
    click GitIgnore "https://github.com/ishaannene/convo-boost/blob/main/.gitignore"

    %% Styles
    classDef cpu fill:#cce5ff,stroke:#333,stroke-width:1px;
    classDef gpu fill:#d4edda,stroke:#333,stroke-width:1px;
    classDef io fill:#e2e3e5,stroke:#333,stroke-width:1px;
    classDef build fill:#f8d7da,stroke:#333,stroke-width:1px;
```
