boomjacky/looper
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat: add Carla plugin host stubs and integration plan

Browse Source
This commit is contained in:
Loic Coenen
2026-05-14 22:11:01 +00:00
committed by Loic Coenen (aider)
parent 5cffec86e7
commit dafc7fe46b
10 changed files with 246 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
client/PLAN.md
View File

@@ -1,136 +0,0 @@
# Plan: Refactor TUI into Standalone FIFO‑Client Binary
## Goal
Extract the TUI from the existing monolithic codebase into a separate `looper-client` binary that communicates with the engine **only** via the FIFO pipe (`/tmp/looper_cmd`).
The TUI must **not** link to any engine source files (`engine.c`, `dispatcher.c`, `carla.c`, etc.) or use their headers beyond shared type definitions (e.g., `command.h`). All state is maintained by the engine; the TUI sends commands and assumes they succeed.
## Background
- The looper engine runs as a separate JACK client and listens for commands on:
- FIFO pipe (`/tmp/looper_cmd`) – text‑based commands
- `looper:control` – MIDI note‑on events
- The current TUI uses a local `Engine` / `AppState` / `dispatcher` that does **not** talk to the real looper. It was designed for unit testing.
## Task 1 – Create a new `client/` directory structure
- Keep existing `client/src/tui.c` and `client/src/tui.h`.
- Remove all `#include` directives that reference engine internal headers:
- `engine.h`
- `dispatcher.h`
- `wav_io.h`
- `transport.h`
- `carla.h`
- Remove any `Engine*`, `AppState`, `DispatchFn`, `Clip`, `MidiClip` usage.
- **Keep** the `FuzzySearch` struct, `draw_rack_view()`, `handle_rack_view()`, `list_wav_files()`, `load_sample_callback`, mouse handling, etc. – they **are not removed**.
However, every call to engine internals (e.g., `carla_get_available_plugins`, `dispatcher_get_state`, `g_dispatch`, `carla.h` functions) **must be replaced** with a stub that does nothing (or prints a debug message) until the engine implements the corresponding FIFO commands.
This keeps the UI code compilable and preserves the structure for future implementation.
## Task 2 – Implement `send_command()` and open FIFO
- Add a function:
```c
int send_command(const char *cmd_line);
```
This function:
- Opens `/tmp/looper_cmd` with `O_WRONLY`.
- Writes the command string (e.g., `"record 0\n"`).
- Appends a newline if missing.
- Closes the file descriptor.
- Returns 0 on success, -1 on error (prints diagnostic to stderr).
- The TUI should call `send_command()` for every user action that should affect the engine.
## Task 3 – Map TUI keys to FIFO commands
Replace each `g_dispatch(action)` with a direct FIFO command string.
**Proposed mapping (simplified – can be refined later):**
| TUI key/action | FIFO command |
|--------------------------------------------|-----------------------------------------------------|
| `'t'` (trigger clip at selected cell) | `record <channel>\n` (channel = `selected_col`) |
| `'d'` (reset clip) | `stop\n` (global stop) |
| `'s'` (trigger scene – current row) | `"scene_next\n"` (or `"scene_add\n"`? TBD) |
| `' '` (toggle transport play/pause) | No corresponding FIFO command yet. Omit for now. |
| `'S'` (stop transport) | `"stop\n"` |
| `'q'` (cycle quantize) | No FIFO equivalent – ignore. |
| `'x'` (reset transport) | `"stop\n"` |
| `'N'` (play next scene) | `"scene_next\n"` |
| `'P'` (play previous scene) | `"scene_prev\n"` |
| `'u'` (undo) | No FIFO equivalent – ignore. |
| `Ctrl+R` (redo) | Ignore. |
| `'v'`, `'V'` (visual mode) | Keep visual selection logic but send commands only for `'d'` and `'y'` actions. |
| `'y'` (yank) | Do nothing (local clipboard only). |
| `'p'` (paste) | For each pasted cell send `"record <ch>\n"`. |
| `'m'` (move mode) | No effect on engine – local navigation. |
| `'z'` (zoom grid selector) | Local navigation only. |
| `'G'` (toggle audio/MIDI grid) | No FIFO command – ignore. |
| `'-'` / `'='` (volume) | No FIFO command – ignore. |
| `\t` (switch to rack view) | Remove entirely. |
| `':'` command mode | Keep for `:q` (quit) and `:rack` commands (the latter can be removed). |
| Escape / `'Q'` | Quit the TUI (no command sent). |
**Channel binding:**
- When the user moves selection to a new column, send `"bind <col>\n"` to ensure subsequent commands affect the correct channel. This can be done in the navigation switch cases.
## Task 4 – Remove all references to `Engine` and `dispatcher`
- Delete the lines:
- `static Engine *g_engine = NULL;`
- `static DispatchFn g_dispatch = NULL;`
- Replace calls like `g_dispatch(action)` with `send_command(formatted_string)`.
- Remove `dispatcher_get_state()` calls – the TUI will no longer query the engine state. Update `draw_cell()` to display only static info (clip index) or a fixed colour (e.g., all green). The state‑dependent colouring is not available without feedback from the engine. For now, show all cells as idle (white) or use a placeholder.
- Remove the line `AppState state; dispatcher_get_state(&state);` inside draw functions.
## Task 5 – Simplify the `tui.h` header
- Replace the function signatures:
```c
void tui_init(void); // no Engine* argument
void tui_run(void); // no Engine* argument
void tui_cleanup(void);
```
- Remove `#include "engine.h"` and `#include "dispatcher.h"`.
- Remove the `Engine*` parameter from the init and run functions.
## Task 6 – Create `client/main.c`
- Write a simple `main()` that:
- Optionally opens the FIFO for writing just to check it exists.
- Calls `tui_init()`.
- Calls `tui_run()`.
- Calls `tui_cleanup()`.
- Returns 0.
## Task 7 – Write `client/makefile`
- Target `looper-client`:
- Compile `src/tui.c` and `src/main.c` (or `src/client.c` if split).
- **Do not** link to any engine `.o` files.
- Link only with `-lncurses` (and `-lm` if needed).
- Example:
```makefile
CC ?= gcc
CFLAGS ?= -Wall -Wextra -g -I../engine/src
LDFLAGS ?= -lncurses -lm
looper-client: src/tui.c src/main.c
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
```
## Task 8 – Remove dead code and unnecessary helpers
- Delete `utils.c` / `utils.h` if they existed only for TUI – but keep all WAV‑related, rack‑related, and fuzzy‑search code (they are now stubs).
- Remove `clip_state_to_string()`, `transport_state_to_string()`, `quantize_mode_to_string()`, `clock_source_to_string()` – they are no longer used for display because we have no `AppState`.
Replace them with static strings that show placeholder text (e.g., `"N/A"`).
- Remove `state_to_color()` – instead use a fixed colour pair (e.g., all cells white) or remove colour entirely, because we have no clip state.
- Remove the `mouse` callback if it relied on `dispatcher_get_state` – but keep the function body as a no‑op.
## Task 9 – Test the new client
- Build `looper-client` and verify it compiles without engine object files.
- Start the engine (`./looper` in `engine/`).
- Run `./looper-client` and press keys that should generate FIFO commands. Use `cat /tmp/looper_cmd` in another terminal to verify output.
- Check that commands like `record 2`, `stop`, `bind 3` appear.
## Notes / Future Improvements
- **State feedback:** The TUI currently shows clip state colours. To restore that, a separate FIFO (or shared memory) for engine‑>client status could be added. Not part of this plan.
- **MIDI grid / rack view:** These depend on engine features not yet exposed via FIFO. They are removed; can be re‑added later.
- **Transport commands:** The engine does not have a dedicated transport play/pause command via FIFO; it relies on MIDI notes. Future FIFO extension needed.
This plan produces a clean, minimal client that interfaces only through the named pipe.
````

43
client/makefile
View File

@@ -1,18 +1,49 @@
CC = gcc
CFLAGS = -Wall -Wextra -Wpedantic -std=c11
CFLAGS = -Wall -Wextra -Wpedantic -std=c11 -Isrc
all: looper-client test_status_parse
looper-client: src/main.c src/tui.c
$(CC) $(CFLAGS) -Isrc -o $@ $^ -lncurses
looper-client: src/main.c src/tui.c $(CARLA_OBJ)
$(CC) $(CFLAGS) -o $@ $^ -lncurses
test_status_parse: tests/test_status_parse.c
$(CC) $(CFLAGS) -Isrc -o test_status_parse tests/test_status_parse.c src/tui.c -lncurses
$(CC) $(CFLAGS) -o test_status_parse tests/test_status_parse.c src/tui.c -lncurses
test: looper-client test_status_parse
# --- Carla host stubs ---
CARLA_OBJ = src/carla_host.o
$(CARLA_OBJ): src/carla_host.c src/carla_host.h
$(CC) $(CFLAGS) -c -o $@ $<
# --- Carla host tests ---
TEST_CARLA_BIN = test_carla_host
TEST_CARLA_OBJ = tests/test_carla_host.o
$(TEST_CARLA_OBJ): tests/test_carla_host.c src/carla_host.h
$(CC) $(CFLAGS) -c -o $@ $<
$(TEST_CARLA_BIN): $(TEST_CARLA_OBJ) $(CARLA_OBJ)
$(CC) $(CFLAGS) -o $@ $^
# ensure the tests directory exists
tests/test_carla_host.o: | tests
# --- send_command test ---
TEST_CLIENT_BIN = test_client
TEST_CLIENT_OBJ = tests/test_client.o
$(TEST_CLIENT_OBJ): tests/test_client.c src/tui.h
$(CC) $(CFLAGS) -c -o $@ $<
$(TEST_CLIENT_BIN): $(TEST_CLIENT_OBJ) src/tui.c
$(CC) $(CFLAGS) -o $@ $^ -lncurses
test: looper-client test_status_parse $(TEST_CARLA_BIN) $(TEST_CLIENT_BIN)
./test_status_parse
./$(TEST_CARLA_BIN)
./$(TEST_CLIENT_BIN)
.PHONY: all test clean
clean:
rm -f looper-client test_status_parse
rm -f looper-client test_status_parse $(TEST_CARLA_BIN) $(TEST_CLIENT_BIN) *.o tests/*.o src/*.o

38
client/src/carla_host.c Normal file
View File

@@ -0,0 +1,38 @@
#include <stddef.h>
#include "carla_host.h"
int carla_load(const char *binary, const char *plugin_id, int *out_id)
{
(void)plugin_id;
(void)out_id;
if (binary == NULL) return -1;
// stub: always fails (will be replaced by real Carla later)
return -1;
}
int carla_unload(int id)
{
(void)id;
return -1; // stub: always fails
}
int carla_connect(int id, const char *port_name, const char *looper_port)
{
(void)id;
(void)port_name;
(void)looper_port;
return -1; // stub: always fails
}
int carla_disconnect(const char *from, const char *to)
{
(void)from;
(void)to;
return 0; // stub: disconnect always succeeds (does nothing)
}
void carla_set_bypass(int id, bool bypass)
{
(void)id;
(void)bypass;
}

14
client/src/carla_host.h Normal file
View File

@@ -0,0 +1,14 @@
#ifndef CARLA_HOST_H
#define CARLA_HOST_H
#include <stdbool.h>
/* All functions return -1 on error, 0 on success (except carla_load which returns 0 on success and sets *out_id) */
int carla_load(const char *binary, const char *plugin_id, int *out_id);
int carla_unload(int id);
int carla_connect(int id, const char *port_name, const char *looper_port);
int carla_disconnect(const char *from, const char *to);
void carla_set_bypass(int id, bool bypass);
#endif

46
client/tests/test_carla_host.c Normal file
View File

@@ -0,0 +1,46 @@
#include <stdio.h>
#include "carla_host.h"
static int tests_passed = 0;
static int tests_failed = 0;
#define ASSERT_EQ(expected, actual, msg) do { \
if ((expected) != (actual)) { \
fprintf(stderr, "FAIL: %s (expected %d, got %d)\n", msg, (int)(expected), (int)(actual)); \
tests_failed++; \
} else { \
printf("PASS: %s\n", msg); \
tests_passed++; \
} \
} while(0)
static void test_carla_load_null_binary(void)
{
int id = -999;
int ret = carla_load(NULL, "someplugin", &id);
ASSERT_EQ(-1, ret, "carla_load(NULL, ...) returns -1");
}
static void test_carla_unload_invalid_id(void)
{
int ret = carla_unload(-1);
ASSERT_EQ(-1, ret, "carla_unload(-1) returns -1");
}
static void test_carla_connect_invalid_id(void)
{
int ret = carla_connect(-1, "out", "looper:in");
ASSERT_EQ(-1, ret, "carla_connect(-1, ...) returns -1");
}
int main(void)
{
printf("=== Carla host stub unit tests ===\n");
test_carla_load_null_binary();
test_carla_unload_invalid_id();
test_carla_connect_invalid_id();
printf("\nResults: %d passed, %d failed\n", tests_passed, tests_failed);
return tests_failed > 0 ? 1 : 0;
}

1
client/tests/test_client.c
View File

@@ -1,3 +1,4 @@
#define _POSIX_C_SOURCE 200809L
#include "tui.h"
#include <stdio.h>
#include <stdlib.h>