control: improve UMP to Midi conversiom

Improve the spa_ump_to_midi function so that it can consume multiple UMP
messages and produce multiple midi messages.

Some UMP messages (like program changes) need to be translated into up
to 3 midi messages. Do this byt adding a state to the function and by
making it consume the input bytes, just like the spa_ump_from_midi
function.

Adapt code to this new world. This is a little API break..
This commit is contained in:
Wim Taymans 2025-08-19 17:41:03 +02:00
parent bf10458604
commit e35a8554f8
13 changed files with 307 additions and 228 deletions

View file

@ -1610,7 +1610,6 @@ static inline int midi_event_write(void *port_buffer,
static void convert_to_event(struct mix_info **mix, uint32_t n_mix, void *midi, bool fix, uint32_t type)
{
uint64_t state = 0;
uint32_t i;
int res = 0;
bool in_sysex = false;
@ -1621,6 +1620,7 @@ static void convert_to_event(struct mix_info **mix, uint32_t n_mix, void *midi,
struct spa_pod_control *control;
size_t size;
uint8_t *data;
uint64_t state = 0;
for (i = 0; i < n_mix; i++) {
struct mix_info *m = mix[i];
@ -1664,34 +1664,36 @@ static void convert_to_event(struct mix_info **mix, uint32_t n_mix, void *midi,
}
case SPA_CONTROL_UMP:
{
uint8_t ev[32];
bool was_sysex = in_sysex;
if (type == TYPE_ID_MIDI) {
uint32_t *d = (uint32_t*)data;
int ev_size = spa_ump_to_midi(d, size, ev, sizeof(ev));
uint8_t ev[32];
const uint32_t *d = (uint32_t*)data;
while (size > 0) {
bool was_sysex = in_sysex;
int ev_size = spa_ump_to_midi(&d, &size, ev, sizeof(ev), &state);
if (ev_size <= 0)
break;
size = ev_size;
data = ev;
if (!in_sysex && ev[0] == 0xf0)
in_sysex = true;
if (in_sysex && ev[ev_size-1] == 0xf7)
in_sysex = false;
} else if (type != TYPE_ID_UMP)
if (was_sysex)
res = midi_event_append(midi, ev, ev_size);
else
res = midi_event_write(midi, control->offset, ev, ev_size, fix);
if (res < 0)
break;
if (was_sysex)
res = midi_event_append(midi, data, size);
else
}
} else if (type == TYPE_ID_UMP) {
res = midi_event_write(midi, control->offset, data, size, fix);
}
if (res < 0)
pw_log_warn("midi %p: can't write event: %s", midi,
spa_strerror(res));
break;
}
}
if (spa_pod_parser_get_control_body(&next->parser,

View file

@ -48,72 +48,98 @@ SPA_API_CONTROL_UMP_UTILS size_t spa_ump_message_size(uint8_t message_type)
return ump_sizes[message_type & 0xf];
}
SPA_API_CONTROL_UMP_UTILS int spa_ump_to_midi(const uint32_t *ump, size_t ump_size,
uint8_t *midi, size_t midi_maxsize)
SPA_API_CONTROL_UMP_UTILS int spa_ump_to_midi(const uint32_t **ump, size_t *ump_size,
uint8_t *midi, size_t midi_maxsize, uint64_t *state)
{
int size = 0;
uint32_t to_consume = 0;
const uint32_t *u = *ump;
if (ump_size < 4)
return 0;
if (*ump_size < 4 ||
(to_consume = (spa_ump_message_size(u[0]>>28) * 4)) > *ump_size) {
to_consume = *ump_size;
goto done;
}
if (midi_maxsize < 8)
return -ENOSPC;
switch (ump[0] >> 28) {
switch (u[0] >> 28) {
case 0x1: /* System Real Time and System Common Messages (except System Exclusive) */
midi[size++] = (ump[0] >> 16) & 0xff;
midi[size++] = (u[0] >> 16) & 0xff;
if (midi[0] >= 0xf1 && midi[0] <= 0xf3) {
midi[size++] = (ump[0] >> 8) & 0x7f;
midi[size++] = (u[0] >> 8) & 0x7f;
if (midi[0] == 0xf2)
midi[size++] = ump[0] & 0x7f;
midi[size++] = u[0] & 0x7f;
}
break;
case 0x2: /* MIDI 1.0 Channel Voice Messages */
midi[size++] = (ump[0] >> 16);
midi[size++] = (ump[0] >> 8);
midi[size++] = (u[0] >> 16);
midi[size++] = (u[0] >> 8);
if (midi[0] < 0xc0 || midi[0] > 0xdf)
midi[size++] = (ump[0]);
midi[size++] = (u[0]);
break;
case 0x3: /* Data Messages (including System Exclusive) */
{
uint8_t status, i, bytes;
if (ump_size < 8)
return 0;
status = (ump[0] >> 20) & 0xf;
bytes = SPA_CLAMP((ump[0] >> 16) & 0xf, 0u, 6u);
status = (u[0] >> 20) & 0xf;
bytes = SPA_CLAMP((u[0] >> 16) & 0xf, 0u, 6u);
if (status == 0 || status == 1)
midi[size++] = 0xf0;
for (i = 0 ; i < bytes; i++)
/* ump[0] >> 8 | ump[0] | ump[1] >> 24 | ump[1] >>16 ... */
midi[size++] = ump[(i+2)/4] >> ((5-i)%4 * 8);
/* u[0] >> 8 | u[0] | u[1] >> 24 | u[1] >>16 ... */
midi[size++] = u[(i+2)/4] >> ((5-i)%4 * 8);
if (status == 0 || status == 3)
midi[size++] = 0xf7;
break;
}
case 0x4: /* MIDI 2.0 Channel Voice Messages */
if (ump_size < 8)
return 0;
midi[size++] = (ump[0] >> 16) | 0x80;
switch (midi[0] & 0xf0) {
{
uint8_t status = (u[0] >> 16) | 0x80;
switch (status & 0xf0) {
case 0xc0:
midi[size++] = (ump[1] >> 24);
/* program/bank change */
if (!(u[0] & 1))
*state = 2;
if (*state == 0) {
midi[size++] = (status & 0xf) | 0xb0;
midi[size++] = 0;
midi[size++] = (u[1] >> 8);
to_consume = 0;
*state = 1;
}
else if (*state == 1) {
midi[size++] = (status & 0xf) | 0xb0;
midi[size++] = 32;
midi[size++] = u[1];
to_consume = 0;
*state = 2;
}
else if (*state == 2) {
midi[size++] = status;
midi[size++] = (u[1] >> 24);
*state = 0;
}
break;
default:
midi[size++] = (ump[0] >> 8) & 0x7f;
midi[size++] = status;
midi[size++] = (u[0] >> 8) & 0x7f;
SPA_FALLTHROUGH;
case 0xd0:
midi[size++] = (ump[1] >> 25);
midi[size++] = (u[1] >> 25);
break;
}
break;
}
case 0x0: /* Utility Messages */
case 0x5: /* Data Messages */
default:
return 0;
break;
}
done:
(*ump_size) -= to_consume;
(*ump) = SPA_PTROFF(*ump, to_consume, uint32_t);
return size;
}

View file

@ -880,15 +880,19 @@ static int process_write(struct seq_state *state)
snd_seq_event_t ev;
uint8_t data[MAX_EVENT_SIZE];
int size;
uint64_t st = 0;
if ((size = spa_ump_to_midi((uint32_t *)body, body_size, data, sizeof(data))) <= 0)
continue;
while (body_size > 0) {
if ((size = spa_ump_to_midi((const uint32_t **)&body, &body_size,
data, sizeof(data), &st)) <= 0)
break;
if (first)
snd_seq_ev_clear(&ev);
if ((size = snd_midi_event_encode(stream->codec, data, size, &ev)) < 0) {
spa_log_warn(state->log, "failed to encode event: %s", snd_strerror(size));
spa_log_warn(state->log, "failed to encode event: %s",
snd_strerror(size));
snd_midi_event_reset_encode(stream->codec);
first = true;
continue;
@ -903,6 +907,8 @@ static int process_write(struct seq_state *state)
snd_seq_ev_set_dest(&ev, port->addr.client, port->addr.port);
snd_seq_ev_schedule_real(&ev, state->event.queue_id, 0, &out_rt);
debug_event(state, "send", &ev);
if ((err = snd_seq_event_output(state->event.hndl, &ev)) < 0) {
spa_log_warn(state->log, "failed to output event: %s",
snd_strerror(err));
@ -911,6 +917,7 @@ static int process_write(struct seq_state *state)
}
}
}
}
snd_seq_drain_output(state->event.hndl);
return res;

View file

@ -1824,18 +1824,20 @@ static int apply_props(struct impl *this, const struct spa_pod *param)
static int apply_midi(struct impl *this, const struct spa_pod *value)
{
struct props *p = &this->props;
uint8_t data[8];
int size;
uint8_t ev[8];
int ev_size;
const uint32_t *body = SPA_POD_BODY_CONST(value);
size_t size = SPA_POD_BODY_SIZE(value);
uint64_t state = 0;
size = spa_ump_to_midi(SPA_POD_BODY(value), SPA_POD_BODY_SIZE(value),
data, sizeof(data));
if (size < 3)
ev_size = spa_ump_to_midi(&body, &size, ev, sizeof(ev), &state);
if (ev_size < 3)
return -EINVAL;
if ((data[0] & 0xf0) != 0xb0 || data[1] != 7)
if ((ev[0] & 0xf0) != 0xb0 || ev[1] != 7)
return 0;
p->volume = data[2] / 127.0f;
p->volume = ev[2] / 127.0f;
set_volume(this);
return 1;
}

View file

@ -788,15 +788,19 @@ static int write_data(struct impl *this, struct spa_data *d)
while (spa_pod_parser_get_control_body(&parser, &c, &c_body) >= 0) {
int size;
uint8_t event[32];
const uint32_t *ump = c_body;
size_t ump_size = c.value.size;
uint64_t state = 0;
if (c.type != SPA_CONTROL_UMP)
continue;
time = SPA_MAX(time, this->current_time + c.offset * SPA_NSEC_PER_SEC / this->rate);
size = spa_ump_to_midi(c_body, c.value.size, event, sizeof(event));
while (ump_size > 0) {
size = spa_ump_to_midi(&ump, &ump_size, event, sizeof(event), &state);
if (size <= 0)
continue;
break;
spa_log_trace(this->log, "%p: output event:0x%x time:%"PRIu64, this,
(size > 0) ? event[0] : 0, time);
@ -813,6 +817,7 @@ static int write_data(struct impl *this, struct spa_data *d)
}
} while (res);
}
}
if ((res = flush_packet(this)) < 0)
return res;

View file

@ -826,11 +826,15 @@ static int impl_node_process(void *object)
case SPA_CONTROL_UMP:
{
uint8_t ev[8];
int ev_size = spa_ump_to_midi((uint32_t*)body, size, ev, sizeof(ev));
const uint32_t *ump = (const uint32_t*)body;
uint64_t state = 0;
while (size > 0) {
int ev_size = spa_ump_to_midi(&ump, &size, ev, sizeof(ev), &state);
if (ev_size <= 0)
break;
spa_pod_builder_control(&builder, control->offset, SPA_CONTROL_Midi);
spa_pod_builder_bytes(&builder, ev, ev_size);
}
break;
}
}

View file

@ -345,16 +345,20 @@ static void midi_to_ffado(struct port *p, float *src, uint32_t n_samples)
while (spa_pod_parser_get_control_body(&parser, &c, &c_body) >= 0) {
uint8_t data[16];
int j, size;
size_t c_size = c.value.size;
uint64_t state = 0;
if (c.type != SPA_CONTROL_UMP)
continue;
size = spa_ump_to_midi(c_body, c.value.size, data, sizeof(data));
if (size <= 0)
continue;
if (index < c.offset)
index = SPA_ROUND_UP_N(c.offset, 8);
while (c_size > 0) {
size = spa_ump_to_midi((const uint32_t**)&c_body, &c_size, data, sizeof(data), &state);
if (size <= 0)
break;
for (j = 0; j < size; j++) {
if (index >= n_samples) {
/* keep events that don't fit for the next cycle */
@ -368,6 +372,7 @@ static void midi_to_ffado(struct port *p, float *src, uint32_t n_samples)
index += 8;
}
}
}
if (unhandled > 0)
pw_log_warn("%u MIDI events dropped (index %d)", unhandled, index);
else if (p->event_pos > 0)

View file

@ -273,13 +273,17 @@ static void midi_to_jack(struct impl *impl, float *dst, float *src, uint32_t n_s
while (spa_pod_parser_get_control_body(&parser, &c, &c_body) >= 0) {
int size;
size_t c_size = c.value.size;
uint64_t state = 0;
if (c.type != SPA_CONTROL_UMP)
continue;
size = spa_ump_to_midi(c_body, c.value.size, &tmp[tmp_size], sizeof(tmp) - tmp_size);
while (c_size > 0) {
size = spa_ump_to_midi((const uint32_t**)&c_body, &c_size,
&tmp[tmp_size], sizeof(tmp) - tmp_size, &state);
if (size <= 0)
continue;
break;
if (impl->fix_midi)
fix_midi_event(&tmp[tmp_size], size);
@ -298,6 +302,7 @@ static void midi_to_jack(struct impl *impl, float *dst, float *src, uint32_t n_s
tmp_size = 0;
}
}
}
}
static void jack_to_midi(float *dst, float *src, uint32_t size)

View file

@ -333,13 +333,16 @@ static void midi_to_netjack2(struct netjack2_peer *peer,
int size;
uint8_t data[16];
bool was_sysex = in_sysex;
size_t c_size = c.value.size;
uint64_t state = 0;
if (c.type != SPA_CONTROL_UMP)
continue;
size = spa_ump_to_midi(c_body, c.value.size, data, sizeof(data));
while (c_size > 0) {
size = spa_ump_to_midi((const uint32_t**)&c_body, &c_size, data, sizeof(data), &state);
if (size <= 0)
continue;
break;
if (c.offset >= n_samples) {
buf->lost_events++;
@ -360,6 +363,7 @@ static void midi_to_netjack2(struct netjack2_peer *peer,
else
n2j_midi_buffer_write(buf, c.offset, data, size);
}
}
if (buf->write_pos > 0)
memmove(SPA_PTROFF(buf, sizeof(*buf) + buf->event_count * sizeof(struct nj2_midi_event), void),
SPA_PTROFF(buf, buf->buffer_size - buf->write_pos, void),

View file

@ -437,14 +437,17 @@ static void rtp_midi_flush_packets(struct impl *impl,
while (spa_pod_parser_get_control_body(parser, &c, &c_body) >= 0) {
uint32_t delta, offset;
uint8_t event[16];
size_t size;
int size;
size_t c_size = c.value.size;
uint64_t state = 0;
if (c.type != SPA_CONTROL_UMP)
continue;
size = spa_ump_to_midi(c_body, c.value.size, event, sizeof(event));
while (c_size > 0) {
size = spa_ump_to_midi((const uint32_t **)&c_body, &c_size, event, sizeof(event), &state);
if (size <= 0)
continue;
break;
offset = c.offset * impl->rate / rate;
@ -472,7 +475,7 @@ static void rtp_midi_flush_packets(struct impl *impl,
impl->seq++;
len = 0;
}
if (size > BUFFER_SIZE || len > BUFFER_SIZE - size) {
if ((unsigned int)size > BUFFER_SIZE || len > BUFFER_SIZE - size) {
pw_log_error("Buffer overflow prevented!");
return; // FIXME: what to do instead?
}
@ -490,6 +493,7 @@ static void rtp_midi_flush_packets(struct impl *impl,
len += write_event(&impl->buffer[len], BUFFER_SIZE - len, delta, event, size);
}
}
}
if (len > 0) {
/* flush last packet */
if (len < 16) {

View file

@ -239,13 +239,17 @@ static void vban_midi_flush_packets(struct impl *impl,
while (spa_pod_parser_get_control_body(parser, &c, &c_body) >= 0) {
int size;
uint8_t event[16];
uint64_t state = 0;
size_t c_size = c.value.size;
if (c.type != SPA_CONTROL_UMP)
continue;
size = spa_ump_to_midi(c_body, c.value.size, event, sizeof(event));
while (c_size > 0) {
size = spa_ump_to_midi((const uint32_t**)&c_body,
&c_size, event, sizeof(event), &state);
if (size <= 0)
continue;
break;
if (len == 0) {
/* start new packet */
@ -261,6 +265,7 @@ static void vban_midi_flush_packets(struct impl *impl,
memcpy(&impl->buffer[len], event, size);
len += size;
}
}
if (len > 0) {
/* flush last packet */
iov[1].iov_len = len;

View file

@ -496,41 +496,46 @@ int midi_file_write_event(struct midi_file *mf, const struct midi_event *event)
{
struct midi_track *tr;
uint32_t tick;
void *data;
void *data, *ev_data;
size_t size;
int res;
int res, ev_size;
uint8_t ev[32];
uint64_t state = 0;
spa_return_val_if_fail(event != NULL, -EINVAL);
spa_return_val_if_fail(mf != NULL, -EINVAL);
spa_return_val_if_fail(event->track == 0, -EINVAL);
spa_return_val_if_fail(event->size > 1, -EINVAL);
switch (event->type) {
case MIDI_EVENT_TYPE_MIDI1:
data = event->data;
size = event->size;
tr = &mf->tracks[event->track];
tick = (uint32_t)(event->sec * (1000000.0 * mf->info.division) / (double)mf->tempo);
while (size > 0) {
switch (event->type) {
case MIDI_EVENT_TYPE_MIDI1:
ev_data = data;
ev_size = size;
size = 0;
break;
case MIDI_EVENT_TYPE_UMP:
data = ev;
size = spa_ump_to_midi((uint32_t*)event->data, event->size, ev, sizeof(ev));
if (size == 0)
return 0;
ev_size = spa_ump_to_midi((const uint32_t**)&data, &size, ev, sizeof(ev), &state);
if (ev_size <= 0)
return ev_size;
ev_data = ev;
break;
default:
return -EINVAL;
}
tr = &mf->tracks[event->track];
tick = (uint32_t)(event->sec * (1000000.0 * mf->info.division) / (double)mf->tempo);
CHECK_RES(write_varlen(mf, tr, tick - tr->tick));
tr->tick = tick;
CHECK_RES(write_n(mf->file, data, size));
tr->size += size;
CHECK_RES(write_n(mf->file, ev_data, ev_size));
tr->size += ev_size;
}
return 0;
}

View file

@ -123,6 +123,7 @@ static int do_ump_to_midi_test(char *ump, char *midi)
size_t m_size, u_size, m_offs = 0;
uint8_t *m_data = alloca(strlen(midi) / 2);
uint32_t *u_data = alloca(strlen(ump) / 2);
uint64_t state = 0;
u_size = parse_ump(ump, u_data, sizeof(u_data));
m_size = parse_midi(midi, m_data, sizeof(m_data));
@ -133,8 +134,9 @@ static int do_ump_to_midi_test(char *ump, char *midi)
while (u_size > 0) {
uint8_t midi[32];
fprintf(stdout, "%zd %08x\n", u_size, *u_data);
int midi_size = spa_ump_to_midi(u_data, u_size,
midi, sizeof(midi));
int midi_size = spa_ump_to_midi((const uint32_t**)&u_data, &u_size,
midi, sizeof(midi), &state);
if (midi_size <= 0)
return midi_size;
@ -145,8 +147,6 @@ static int do_ump_to_midi_test(char *ump, char *midi)
fprintf(stdout, "%08x %08x\n", m_data[m_offs], midi[i]);
spa_assert(m_data[m_offs++] == midi[i]);
}
u_size -= spa_ump_message_size(*u_data >> 28) * 4;
u_data += spa_ump_message_size(*u_data >> 28);
}
return 0;
}
@ -160,6 +160,11 @@ PWTEST(control_ump_to_midi)
spa_assert(do_ump_to_midi_test("30160102 03040506 30260708 09101112 30311300 00000000",
"f0 01 02 03 04 05 06 07 08 09 10 11 12 13 f7") >= 0);
spa_assert(do_ump_to_midi_test("40cf0000 11000000", "cf 11") >= 0);
spa_assert(do_ump_to_midi_test("40cf0001 11002233", "bf 00 22 bf 20 33 cf 11") >= 0);
return PWTEST_PASS;
}