# wooters/minidsp architecture

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

- Interactive diagram: https://gitdiagram.com/wooters/minidsp
- Repository: https://github.com/wooters/minidsp

## Overview

##### Project type and purpose
- Project type: a small, open-source C library (“miniDSP”) offering digital signal-processing (DSP) routines plus audio I/O and plotting utilities.
- Purpose: let applications record/play audio, read/write audio files, compute cross-correlations and delays, and invoke gnuplot for visualization.

##### File structure
- Top-level C modules:
– biquad.c / biquad.h  (IIR biquad filter routines)
– fileio.c / fileio.h  (read/write audio via libsndfile, HTK format output)
– liveio.c / liveio.h  (live audio capture/playback via PortAudio)
– minidsp.c / minidsp.h  (collector interface, high-level DSP functions like GCC-PHAT)
- Tests folder: examples and test programs that link against libminidsp.a and gnuplot_i:
– gcc_phat_test, gcc_phat_multi_test, testliveio, testliverec
- Build and configuration: Makefile at root and tests/Makefile; Doxyfile for docs.

##### README for additional insights
- Dependencies: FFTW, PortAudio, libsndfile, gnuplot_i.
- Typical workflow: user allocates buffers, calls live I/O or file I/O APIs, processes data via DSP calls, optionally plots via gnuplot_i.

##### Components and interactions
a. Main components
- Core Library (“libminidsp”)
– DSP Module (minidsp.c/minidsp.h: MD_gcc, MD_get_delay, MD_get_multiple_delays)
– Filter Module (biquad.c)
– File I/O Module (fileio.c)
– Live I/O Module (liveio.c)
- External Dependencies
– FFTW (FFT engine)
– PortAudio (live audio input/output)
– libsndfile (file-based audio I/O)
– gnuplot_i (plotting interface)
- Client Applications / Test Binaries
– testliverec, testliveio, gcc_phat_test, etc.
b. Relationships and data flow
- From Client → libminidsp API
- Within libminidsp: File I/O and Live I/O modules feed raw audio buffers into DSP module; DSP outputs processed data → Client or plotting.
- DSP routines invoke FFTW for transforms.
- Plotting routines link libminidsp data to gnuplot_i.
c. Architectural patterns
- Layered design:
– Hardware Abstraction (PortAudio) and File Abstraction (libsndfile)
– Core DSP Layer (FFTW-based algorithms)
– Utility Layer (filters, plotting wrapper)
- Test harness = thin client layers demonstrating API usage.
d. Key technologies/frameworks
- C99, Makefile build
- External libs: FFTW, PortAudio, libsndfile, gnuplot_i

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client/Test Applications
    subgraph "Client/Test Applications" 
        direction TB
        GPAT["gcc_phat_test.c"]:::tests
        GPMUL["gcc_phat_multi_test.c"]:::tests
        TIO["testliveio.c"]:::tests
        TRC["testliverec.c"]:::tests
        TMK["tests/Makefile"]:::tests
    end

    %% Core Library
    subgraph "Core Library (libminidsp)" 
        direction TB
        DSP["Core DSP Module\n(minidsp.c/minidsp.h)"]:::core
        FILT["Filter Module\n(biquad.c/biquad.h)"]:::core
        FIO["File I/O Module\n(fileio.c/fileio.h)"]:::core
        LIO["Live I/O Module\n(liveio.c/liveio.h)"]:::core
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        FFTW["FFTW"]:::dep
        PA["PortAudio"]:::dep
        SNDF["libsndfile"]:::dep
        GNUP["gnuplot_i"]:::dep
    end

    %% Build & Docs
    subgraph "Build & Docs"
        direction TB
        MK["Makefile"]:::build
        DOX["Doxyfile"]:::build
    end

    %% Connections
    GPAT -->|"links to libminidsp.a"| DSP
    GPMUL -->|"links to libminidsp.a"| DSP
    TIO -->|"links to libminidsp.a"| DSP
    TRC -->|"links to libminidsp.a"| DSP

    DSP -->|"uses FFTW for FFT transforms"| FFTW
    FILT -->|"IIR routines"| DSP
    FIO -->|"reads/writes audio buffers"| DSP
    FIO -->|"↔ libsndfile"| SNDF
    LIO -->|"↔ PortAudio callback"| PA
    DSP -->|"plot data via"| GNUP

    MK -->|"builds libminidsp and tests"| DSP
    DOX -->|"documents API"| DSP

    %% Click Events
    click DSP "https://github.com/wooters/minidsp/blob/master/minidsp.c"
    click DSP "https://github.com/wooters/minidsp/blob/master/minidsp.h"
    click FILT "https://github.com/wooters/minidsp/blob/master/biquad.c"
    click FILT "https://github.com/wooters/minidsp/blob/master/biquad.h"
    click FIO "https://github.com/wooters/minidsp/blob/master/fileio.c"
    click FIO "https://github.com/wooters/minidsp/blob/master/fileio.h"
    click LIO "https://github.com/wooters/minidsp/blob/master/liveio.c"
    click LIO "https://github.com/wooters/minidsp/blob/master/liveio.h"
    click GPAT "https://github.com/wooters/minidsp/blob/master/tests/gcc_phat_test.c"
    click GPMUL "https://github.com/wooters/minidsp/blob/master/tests/gcc_phat_multi_test.c"
    click TIO "https://github.com/wooters/minidsp/blob/master/tests/testliveio.c"
    click TRC "https://github.com/wooters/minidsp/blob/master/tests/testliverec.c"
    click TMK "https://github.com/wooters/minidsp/tree/master/tests/Makefile"
    click MK "https://github.com/wooters/minidsp/tree/master/Makefile"
    click DOX "https://github.com/wooters/minidsp/tree/master/Doxyfile"

    %% Styles
    classDef core fill:#f9f,stroke:#333,stroke-width:1px;
    classDef dep fill:#9f9,stroke:#333,stroke-width:1px;
    classDef tests fill:#ff9,stroke:#333,stroke-width:1px;
    classDef build fill:#9cf,stroke:#333,stroke-width:1px;
```
