core/retro_control.h at 1b40a077e41f · doomsdayone/retro-remote-debug-controller

# 1b40a077e41f retro-remote-debug-controller / core / retro_control.h

7.8 KiB · Objective-C · last changed 0.5.0: game controller injection (POST/GET /pad) 3 months ago source blame history raw

/* retro_control.h — portable emulator control server (see ../SPEC.md).
 *
 * A retro-platform emulator implements the small read-only backend below and
 * calls retro_control_start(). The shared server (retro_control.c) owns the
 * socket loop, HTTP parsing, PPM/JSON encoding, and control flow
 * (pause / step / free-run). It always binds 127.0.0.1. Contract version is
 * RETRO_CONTROL_CONTRACT (below); the server advertises the highest level whose
 * backend callbacks are all present.
 *
 * Integration is three calls in the emulator's main loop:
 *   retro_control_service();                 // once per iteration (cheap)
 *   if (!retro_control_running()) { idle; }  // gate advancing the machine
 *   ... run one instruction / frame ...
 *   if (frame_completed) retro_control_on_frame();
 *
 * Threading: the server runs on its own thread but never touches machine state
 * there. State-reading endpoints (/mem, /regs, /screenshot) are executed inside
 * retro_control_service() ON THE EMULATOR THREAD, so every read is consistent.
 * The backend callbacks are therefore called from the emulator thread (except
 * get_frame_count, which the server may also read for /status — make it a plain
 * atomic-ish counter read).
 */
#ifndef RETRO_CONTROL_H
#define RETRO_CONTROL_H

#include <stdint.h>
#include <stddef.h>

/* Highest contract the core implements. The server advertises the highest level
 * whose backend callbacks are all present: 0.5.0 needs set_pad + get_pad (on
 * top of 0.4); 0.4.0 needs set_pointer + get_pointer (on top of 0.3); 0.3.0
 * needs inject_key + write_mem + capture_audio; 0.2.0 needs inject_key; else
 * 0.1.0. Keeps a partial backend honest. */
#define RETRO_CONTROL_CONTRACT "0.5.0"

/* Native framebuffer pixel layout; the server swizzles to PPM RGB. */
typedef enum {
    RETRO_PIX_RGB888 = 0,   /* 3 bytes/px: R,G,B                       */
    RETRO_PIX_RGBA8888,     /* 4 bytes/px: R,G,B,A                     */
    RETRO_PIX_BGRA8888      /* 4 bytes/px: B,G,R,A (x16 framebuffer)   */
} retro_pix_fmt_t;

typedef struct {
    const uint8_t *pixels;  /* start of the current complete frame     */
    int width;
    int height;
    retro_pix_fmt_t fmt;
} retro_framebuffer_t;

/* Key action for inject_key (0.2). */
typedef enum {
    RETRO_KEY_TAP  = 0,   /* press then release */
    RETRO_KEY_DOWN = 1,   /* press / hold       */
    RETRO_KEY_UP   = 2    /* release            */
} retro_key_action_t;

/* The emulator implements these. Any may be NULL: the matching endpoint then
 * returns 501 Not Implemented. */
typedef struct retro_control_backend {
    const char *platform;   /* "x16" | "neo6502" | "agon" | ...        */
    const char *emulator;   /* human name, e.g. "x16emu"               */

    /* Debug-read up to min(len, out_cap) bytes at addr into out, side-effect
     * free. bank is the optional bank selector (<0 = current bank). Returns the
     * number of bytes written. */
    uint32_t (*read_mem)(uint32_t addr, int32_t bank, uint32_t len,
                         uint8_t *out, uint32_t out_cap);

    /* Write a JSON object of registers into buf (NUL-terminated). */
    void (*get_regs_json)(char *buf, size_t cap);

    /* Report the current complete-frame framebuffer. */
    void (*get_framebuffer)(retro_framebuffer_t *out);

    /* Monotonic completed-frame counter. */
    uint64_t (*get_frame_count)(void);

    /* 0.2: inject a key. is_text=1 => `value` is a character code point;
     * is_text=0 => `value` is a raw platform key code. `action` is a
     * retro_key_action_t. Return 1 on success, 0 if unmappable (server -> 400).
     * NULL => /key returns 501 and the server advertises contract 0.1.0. */
    int (*inject_key)(int is_text, uint32_t value, int action);

    /* 0.2: soft/cold reset the machine. NULL => /reset returns 501. */
    void (*reset)(void);

    /* 0.3: write len bytes from `in` at addr (debug/state poke; bank<0 =
     * current). Intended for RAM/state — I/O-register writes may trigger device
     * side effects. Return bytes written. NULL => POST /mem returns 501. */
    uint32_t (*write_mem)(uint32_t addr, int32_t bank, uint32_t len,
                          const uint8_t *in);

    /* 0.3: drain up to `cap` interleaved signed-16-bit audio samples the
     * emulator has synthesised since the last call into `out`; set *rate and
     * *channels; set *dropped to samples lost to overflow since the last drain.
     * Return the number of int16 samples written. NULL => /audio returns 501. */
    uint32_t (*capture_audio)(int16_t *out, uint32_t cap,
                              int *rate, int *channels, uint32_t *dropped);

    /* 0.4: inject a pointer (mouse) move/click through the platform's native
     * pointer path. `absolute` nonzero => (x,y) are absolute pointer
     * coordinates (framebuffer/pointer space); zero => (x,y) are relative
     * deltas applied to the current position. `buttons` is a bitmask
     * (bit0 = primary, bit1 = secondary), or -1 to leave the button state
     * unchanged (a pure move). Return 1 on success, 0 if the platform has no
     * pointer (server -> 400). NULL => POST /pointer returns 501. */
    int (*set_pointer)(int absolute, int32_t x, int32_t y, int buttons);

    /* 0.4: report the current pointer position and button bitmask (same
     * semantics as set_pointer's `buttons`). Return 1 on success (values
     * written), 0 if no pointer is available. NULL => GET /pointer returns 501. */
    int (*get_pointer)(int32_t *x, int32_t *y, int *buttons);

    /* 0.5: present a virtual game controller at `index` and set what is held.
     *
     * `buttons` is the canonical mask (SPEC "Canonical button layout"): bit0
     * LEFT, 1 RIGHT, 2 UP, 3 DOWN, 4 A, 5 B, 6 X, 7 Y, 8 START, 9 SELECT,
     * 10 L, 11 R -- the SNES/Neo6502 native order. A backend whose hardware
     * disagrees converts here, so a test never learns which machine it is on.
     * -1 leaves the mask unchanged.
     *
     * `connected` is 1 to present the pad, 0 to unplug it, -1 to leave the
     * presence unchanged. Unplugging is testable behaviour in its own right:
     * a program that asks "is a pad there" before offering two-player needs
     * both answers.
     *
     * A pad is a LEVEL, not an event -- the state persists across frames until
     * changed, unlike inject_key's TAP.
     *
     * MUST drive the same path a real pad takes. On an emulator reading SDL
     * joysticks that means presenting a virtual device the existing read path
     * picks up, NOT calling into SDL: headless CI has no joystick, which is
     * the case this exists for.
     *
     * Return 1 on success, 0 if the platform has no controller support
     * (server -> 400). NULL => POST /pad returns 501. */
    int (*set_pad)(int index, int buttons, int connected);

    /* 0.5: report a pad's presence and held mask (same layout as set_pad).
     * Return 1 on success (values written), 0 if unsupported. NULL => GET /pad
     * returns 501. */
    int (*get_pad)(int index, int *buttons, int *connected);
} retro_control_backend_t;

/* Start the server thread bound to 127.0.0.1:port. Non-blocking; 0 on success,
 * negative on error. backend must outlive the server. */
int  retro_control_start(int port, const retro_control_backend_t *backend);

/* Drain a pending control request. Call once per main-loop iteration, at an
 * instruction/frame boundary. Cheap no-op when idle and when control is off. */
void retro_control_service(void);

/* Nonzero => the machine should advance this iteration. Returns 1 always when
 * control is off or the machine is free-running; 0 when paused with no steps
 * left. */
int  retro_control_running(void);

/* Call when a video frame completes. Drives /step (decrements the step budget,
 * halts and answers when it reaches zero). No-op when control is off. */
void retro_control_on_frame(void);

/* Stop the server (optional; process exit is fine too). */
void retro_control_stop(void);

#endif /* RETRO_CONTROL_H */

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1	/* retro_control.h — portable emulator control server (see ../SPEC.md).
2	*
3	* A retro-platform emulator implements the small read-only backend below and
4	* calls retro_control_start(). The shared server (retro_control.c) owns the
5	* socket loop, HTTP parsing, PPM/JSON encoding, and control flow
6	* (pause / step / free-run). It always binds 127.0.0.1. Contract version is
7	* RETRO_CONTROL_CONTRACT (below); the server advertises the highest level whose
8	* backend callbacks are all present.
9	*
10	* Integration is three calls in the emulator's main loop:
11	* retro_control_service(); // once per iteration (cheap)
12	* if (!retro_control_running()) { idle; } // gate advancing the machine
13	* ... run one instruction / frame ...
14	* if (frame_completed) retro_control_on_frame();
15	*
16	* Threading: the server runs on its own thread but never touches machine state
17	* there. State-reading endpoints (/mem, /regs, /screenshot) are executed inside
18	* retro_control_service() ON THE EMULATOR THREAD, so every read is consistent.
19	* The backend callbacks are therefore called from the emulator thread (except
20	* get_frame_count, which the server may also read for /status — make it a plain
21	* atomic-ish counter read).
22	*/
23	#ifndef RETRO_CONTROL_H
24	#define RETRO_CONTROL_H
25
26	#include <stdint.h>
27	#include <stddef.h>
28
29	/* Highest contract the core implements. The server advertises the highest level
30	* whose backend callbacks are all present: 0.5.0 needs set_pad + get_pad (on
31	* top of 0.4); 0.4.0 needs set_pointer + get_pointer (on top of 0.3); 0.3.0
32	* needs inject_key + write_mem + capture_audio; 0.2.0 needs inject_key; else
33	* 0.1.0. Keeps a partial backend honest. */
34	#define RETRO_CONTROL_CONTRACT "0.5.0"
35
36	/* Native framebuffer pixel layout; the server swizzles to PPM RGB. */
37	typedef enum {
38	RETRO_PIX_RGB888 = 0, /* 3 bytes/px: R,G,B */
39	RETRO_PIX_RGBA8888, /* 4 bytes/px: R,G,B,A */
40	RETRO_PIX_BGRA8888 /* 4 bytes/px: B,G,R,A (x16 framebuffer) */
41	} retro_pix_fmt_t;
42
43	typedef struct {
44	const uint8_t pixels; / start of the current complete frame */
45	int width;
46	int height;
47	retro_pix_fmt_t fmt;
48	} retro_framebuffer_t;
49
50	/* Key action for inject_key (0.2). */
51	typedef enum {
52	RETRO_KEY_TAP = 0, /* press then release */
53	RETRO_KEY_DOWN = 1, /* press / hold */
54	RETRO_KEY_UP = 2 /* release */
55	} retro_key_action_t;
56
57	/* The emulator implements these. Any may be NULL: the matching endpoint then
58	* returns 501 Not Implemented. */
59	typedef struct retro_control_backend {
60	const char platform; / "x16" \| "neo6502" \| "agon" \| ... */
61	const char emulator; / human name, e.g. "x16emu" */
62
63	/* Debug-read up to min(len, out_cap) bytes at addr into out, side-effect
64	* free. bank is the optional bank selector (<0 = current bank). Returns the
65	* number of bytes written. */
66	uint32_t (*read_mem)(uint32_t addr, int32_t bank, uint32_t len,
67	uint8_t *out, uint32_t out_cap);
68
69	/* Write a JSON object of registers into buf (NUL-terminated). */
70	void (get_regs_json)(char buf, size_t cap);
71
72	/* Report the current complete-frame framebuffer. */
73	void (get_framebuffer)(retro_framebuffer_t out);
74
75	/* Monotonic completed-frame counter. */
76	uint64_t (*get_frame_count)(void);
77
78	/* 0.2: inject a key. is_text=1 => `value` is a character code point;
79	* is_text=0 => `value` is a raw platform key code. `action` is a
80	* retro_key_action_t. Return 1 on success, 0 if unmappable (server -> 400).
81	* NULL => /key returns 501 and the server advertises contract 0.1.0. */
82	int (*inject_key)(int is_text, uint32_t value, int action);
83
84	/* 0.2: soft/cold reset the machine. NULL => /reset returns 501. */
85	void (*reset)(void);
86
87	/* 0.3: write len bytes from `in` at addr (debug/state poke; bank<0 =
88	* current). Intended for RAM/state — I/O-register writes may trigger device
89	* side effects. Return bytes written. NULL => POST /mem returns 501. */
90	uint32_t (*write_mem)(uint32_t addr, int32_t bank, uint32_t len,
91	const uint8_t *in);
92
93	/* 0.3: drain up to `cap` interleaved signed-16-bit audio samples the
94	* emulator has synthesised since the last call into `out`; set *rate and
95	* channels; set dropped to samples lost to overflow since the last drain.
96	* Return the number of int16 samples written. NULL => /audio returns 501. */
97	uint32_t (capture_audio)(int16_t out, uint32_t cap,
98	int rate, int channels, uint32_t *dropped);
99
100	/* 0.4: inject a pointer (mouse) move/click through the platform's native
101	* pointer path. `absolute` nonzero => (x,y) are absolute pointer
102	* coordinates (framebuffer/pointer space); zero => (x,y) are relative
103	* deltas applied to the current position. `buttons` is a bitmask
104	* (bit0 = primary, bit1 = secondary), or -1 to leave the button state
105	* unchanged (a pure move). Return 1 on success, 0 if the platform has no
106	* pointer (server -> 400). NULL => POST /pointer returns 501. */
107	int (*set_pointer)(int absolute, int32_t x, int32_t y, int buttons);
108
109	/* 0.4: report the current pointer position and button bitmask (same
110	* semantics as set_pointer's `buttons`). Return 1 on success (values
111	* written), 0 if no pointer is available. NULL => GET /pointer returns 501. */
112	int (get_pointer)(int32_t x, int32_t y, int buttons);
113
114	/* 0.5: present a virtual game controller at `index` and set what is held.
115	*
116	* `buttons` is the canonical mask (SPEC "Canonical button layout"): bit0
117	* LEFT, 1 RIGHT, 2 UP, 3 DOWN, 4 A, 5 B, 6 X, 7 Y, 8 START, 9 SELECT,
118	* 10 L, 11 R -- the SNES/Neo6502 native order. A backend whose hardware
119	* disagrees converts here, so a test never learns which machine it is on.
120	* -1 leaves the mask unchanged.
121	*
122	* `connected` is 1 to present the pad, 0 to unplug it, -1 to leave the
123	* presence unchanged. Unplugging is testable behaviour in its own right:
124	* a program that asks "is a pad there" before offering two-player needs
125	* both answers.
126	*
127	* A pad is a LEVEL, not an event -- the state persists across frames until
128	* changed, unlike inject_key's TAP.
129	*
130	* MUST drive the same path a real pad takes. On an emulator reading SDL
131	* joysticks that means presenting a virtual device the existing read path
132	* picks up, NOT calling into SDL: headless CI has no joystick, which is
133	* the case this exists for.
134	*
135	* Return 1 on success, 0 if the platform has no controller support
136	* (server -> 400). NULL => POST /pad returns 501. */
137	int (*set_pad)(int index, int buttons, int connected);
138
139	/* 0.5: report a pad's presence and held mask (same layout as set_pad).
140	* Return 1 on success (values written), 0 if unsupported. NULL => GET /pad
141	* returns 501. */
142	int (get_pad)(int index, int buttons, int *connected);
143	} retro_control_backend_t;
144
145	/* Start the server thread bound to 127.0.0.1:port. Non-blocking; 0 on success,
146	* negative on error. backend must outlive the server. */
147	int retro_control_start(int port, const retro_control_backend_t *backend);
148
149	/* Drain a pending control request. Call once per main-loop iteration, at an
150	* instruction/frame boundary. Cheap no-op when idle and when control is off. */
151	void retro_control_service(void);
152
153	/* Nonzero => the machine should advance this iteration. Returns 1 always when
154	* control is off or the machine is free-running; 0 when paused with no steps
155	* left. */
156	int retro_control_running(void);
157
158	/* Call when a video frame completes. Drives /step (decrements the step budget,
159	* halts and answers when it reaches zero). No-op when control is off. */
160	void retro_control_on_frame(void);
161
162	/* Stop the server (optional; process exit is fine too). */
163	void retro_control_stop(void);
164
165	#endif /* RETRO_CONTROL_H */

Keyboard