Skip to content

Make USB MIDI interface names customizable #9146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 6, 2024
Merged

Make USB MIDI interface names customizable #9146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
814ebc6
Make USB MIDI interface names customizable
brushmate Apr 5, 2024
e97ac18
factor out name-setting in usb_midi_set_names()
dhalbert Apr 6, 2024
9d8eebc
shrink pygamer and pybadge
dhalbert Apr 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ports/atmel-samd/boards/pybadge/mpconfigboard.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ CIRCUITPY_AESIO = 0
CIRCUITPY_FLOPPYIO = 0
CIRCUITPY_FRAMEBUFFERIO = 0
CIRCUITPY_GIFIO = 0
CIRCUITPY_I2CDISPLAYBUS = 0
CIRCUITPY_JPEGIO = 0
CIRCUITPY_KEYPAD = 1
CIRCUITPY_PARALLELDISPLAYBUS= 0
CIRCUITPY_STAGE = 1

FROZEN_MPY_DIRS += $(TOP)/frozen/circuitpython-stage/pybadge
2 changes: 2 additions & 0 deletions ports/atmel-samd/boards/pygamer/mpconfigboard.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ CIRCUITPY_AESIO = 0
CIRCUITPY_FLOPPYIO = 0
CIRCUITPY_FRAMEBUFFERIO = 0
CIRCUITPY_GIFIO = 0
CIRCUITPY_I2CDISPLAYBUS = 0
CIRCUITPY_JPEGIO = 0
CIRCUITPY_KEYPAD = 1
CIRCUITPY_PARALLELDISPLAYBUS= 0
CIRCUITPY_STAGE = 1

FROZEN_MPY_DIRS += $(TOP)/frozen/circuitpython-stage/pygamer
78 changes: 72 additions & 6 deletions shared-bindings/usb_midi/__init__.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,79 @@ STATIC mp_obj_t usb_midi_enable(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(usb_midi_enable_obj, usb_midi_enable);


static void set_name(mp_obj_t name_obj, qstr arg_name_qstr, char **custom_name_p) {
if (name_obj != mp_const_none) {
mp_buffer_info_t name;
mp_get_buffer_raise(name_obj, &name, MP_BUFFER_READ);
mp_arg_validate_length_range(name.len, 1, 126, arg_name_qstr);

if (*custom_name_p == NULL) {
*custom_name_p = port_malloc(sizeof(char) * 128, false);
}

memcpy(*custom_name_p, name.buf, name.len);
(*custom_name_p)[name.len] = 0;
}
}


//| def set_names(
//| self,
//| *,
//| streaming_interface_name: Optional[str] = None,
//| audio_control_interface_name: Optional[str] = None,
//| in_jack_name: Optional[str] = None,
//| out_jack_name: Optional[str] = None
//| ) -> None:
//| """Override the MIDI interface names in the USB Interface Descriptor.
//|
//| :param Optional[str] streaming_interface_name: an ASCII string (or buffer) of at most 126 characters, or ``None`` to use the default name.
//| :param Optional[str] audio_control_interface_name: an ASCII string (or buffer) of at most 126 characters, or ``None`` to use the default name.
//| :param Optional[str] in_jack_name: an ASCII string (or buffer) of at most 126 characters, or ``None`` to use the default name.
//| :param Optional[str] out_jack_name: an ASCII string (or buffer) of at most 126 characters, or ``None`` to use the default name.
//|
//| This method must be called in boot.py to have any effect.
//|
//| Not available on boards without native USB support.
//| """
//| ...
//|
STATIC mp_obj_t usb_midi_set_names(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_streaming_interface_name, ARG_audio_control_interface_name, ARG_in_jack_name, ARG_out_jack_name };
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_streaming_interface_name, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
{ MP_QSTR_audio_control_interface_name, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
{ MP_QSTR_in_jack_name, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
{ MP_QSTR_out_jack_name, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
};
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, (mp_arg_val_t *)&args);

mp_obj_t streaming_interface_name_obj = args[ARG_streaming_interface_name].u_obj;
set_name(streaming_interface_name_obj, MP_QSTR_streaming_interface_name, &custom_usb_midi_streaming_interface_name);

mp_obj_t audio_control_interface_name_obj = args[ARG_audio_control_interface_name].u_obj;
set_name(audio_control_interface_name_obj, MP_QSTR_audio_control_interface_name, &custom_usb_midi_audio_control_interface_name);

mp_obj_t in_jack_name_obj = args[ARG_in_jack_name].u_obj;
set_name(in_jack_name_obj, MP_QSTR_in_jack_name, &custom_usb_midi_in_jack_name);

mp_obj_t out_jack_name_obj = args[ARG_out_jack_name].u_obj;
set_name(out_jack_name_obj, MP_QSTR_out_jack_name, &custom_usb_midi_out_jack_name);

return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_KW(usb_midi_set_names_obj, 0, usb_midi_set_names);

mp_map_elem_t usb_midi_module_globals_table[] = {
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_usb_midi) },
{ MP_ROM_QSTR(MP_QSTR_disable), MP_OBJ_FROM_PTR(&usb_midi_disable_obj) },
{ MP_ROM_QSTR(MP_QSTR_enable), MP_OBJ_FROM_PTR(&usb_midi_enable_obj) },
{ MP_ROM_QSTR(MP_QSTR_ports), mp_const_empty_tuple },
{ MP_ROM_QSTR(MP_QSTR_PortIn), MP_OBJ_FROM_PTR(&usb_midi_portin_type) },
{ MP_ROM_QSTR(MP_QSTR_PortOut), MP_OBJ_FROM_PTR(&usb_midi_portout_type) },
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_usb_midi) },
{ MP_ROM_QSTR(MP_QSTR_disable), MP_OBJ_FROM_PTR(&usb_midi_disable_obj) },
{ MP_ROM_QSTR(MP_QSTR_enable), MP_OBJ_FROM_PTR(&usb_midi_enable_obj) },
{ MP_ROM_QSTR(MP_QSTR_set_names), MP_OBJ_FROM_PTR(&usb_midi_set_names_obj) },
{ MP_ROM_QSTR(MP_QSTR_ports), mp_const_empty_tuple },
{ MP_ROM_QSTR(MP_QSTR_PortIn), MP_OBJ_FROM_PTR(&usb_midi_portin_type) },
{ MP_ROM_QSTR(MP_QSTR_PortOut), MP_OBJ_FROM_PTR(&usb_midi_portout_type) },
};

// This isn't const so we can set ports dynamically.
Expand Down
37 changes: 33 additions & 4 deletions shared-module/usb_midi/__init__.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,17 @@ size_t usb_midi_descriptor_length(void) {
return sizeof(usb_midi_descriptor_template);
}

static const char midi_streaming_interface_name[] = USB_INTERFACE_NAME " MIDI";
static const char midi_audio_control_interface_name[] = USB_INTERFACE_NAME " Audio";
static const char midi_in_jack_name[] = USB_INTERFACE_NAME " usb_midi.ports[0]";
static const char midi_out_jack_name[] = USB_INTERFACE_NAME " usb_midi.ports[0]";
char *custom_usb_midi_streaming_interface_name = NULL;
char *custom_usb_midi_audio_control_interface_name = NULL;
char *custom_usb_midi_in_jack_name = NULL;
char *custom_usb_midi_out_jack_name = NULL;

size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, descriptor_counts_t *descriptor_counts, uint8_t *current_interface_string) {
const char *midi_streaming_interface_name;
const char *midi_audio_control_interface_name;
const char *midi_in_jack_name;
const char *midi_out_jack_name;

memcpy(descriptor_buf, usb_midi_descriptor_template, sizeof(usb_midi_descriptor_template));

descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_NUMBER_INDEX] = descriptor_counts->current_interface;
Expand All @@ -200,18 +205,42 @@ size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, descriptor_counts_t *des
descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX_2] = descriptor_counts->current_interface;
descriptor_counts->current_interface++;

if (custom_usb_midi_streaming_interface_name == NULL) {
midi_streaming_interface_name = USB_INTERFACE_NAME " MIDI";
} else {
midi_streaming_interface_name = custom_usb_midi_streaming_interface_name;
}

usb_add_interface_string(*current_interface_string, midi_streaming_interface_name);
descriptor_buf[MIDI_STREAMING_INTERFACE_STRING_INDEX] = *current_interface_string;
(*current_interface_string)++;

if (custom_usb_midi_audio_control_interface_name == NULL) {
midi_audio_control_interface_name = USB_INTERFACE_NAME " Audio";
} else {
midi_audio_control_interface_name = custom_usb_midi_audio_control_interface_name;
}

usb_add_interface_string(*current_interface_string, midi_audio_control_interface_name);
descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_STRING_INDEX] = *current_interface_string;
(*current_interface_string)++;

if (custom_usb_midi_in_jack_name == NULL) {
midi_in_jack_name = USB_INTERFACE_NAME " usb_midi.ports[0]";
} else {
midi_in_jack_name = custom_usb_midi_in_jack_name;
}

usb_add_interface_string(*current_interface_string, midi_in_jack_name);
descriptor_buf[MIDI_IN_JACK_STRING_INDEX] = *current_interface_string;
(*current_interface_string)++;

if (custom_usb_midi_out_jack_name == NULL) {
midi_out_jack_name = USB_INTERFACE_NAME " usb_midi.ports[0]";
} else {
midi_out_jack_name = custom_usb_midi_out_jack_name;
}

usb_add_interface_string(*current_interface_string, midi_out_jack_name);
descriptor_buf[MIDI_OUT_JACK_STRING_INDEX] = *current_interface_string;
(*current_interface_string)++;
Expand Down
5 changes: 5 additions & 0 deletions shared-module/usb_midi/__init__.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,9 @@ void usb_midi_setup_ports(void);
size_t usb_midi_descriptor_length(void);
size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, descriptor_counts_t *descriptor_counts, uint8_t *current_interface_string);

extern char *custom_usb_midi_streaming_interface_name;
extern char *custom_usb_midi_audio_control_interface_name;
extern char *custom_usb_midi_in_jack_name;
extern char *custom_usb_midi_out_jack_name;

#endif /* SHARED_MODULE_USB_MIDI___INIT___H */