1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
# SPDX-FileCopyrightText: 2013 Ole Martin Bjorndalen <ombdalen@gmail.com>
#
# SPDX-License-Identifier: MIT
"""Backend for python-rtmidi:
http://pypi.python.org/pypi/python-rtmidi/
"""
import threading
import rtmidi
from .. import ports
from ..messages import Message
from ._parser_queue import ParserQueue
from .rtmidi_utils import expand_alsa_port_name
def _get_api_lookup():
api_to_name = {}
name_to_api = {}
for name in dir(rtmidi):
if name.startswith('API_'):
value = getattr(rtmidi, name)
name = name.replace('API_', '')
name_to_api[name] = value
api_to_name[value] = name
return api_to_name, name_to_api
_api_to_name, _name_to_api = _get_api_lookup()
def _get_api_id(name=None):
if name is None:
return rtmidi.API_UNSPECIFIED
try:
api = _name_to_api[name]
except KeyError as ke:
raise ValueError(f'unknown API {name}') from ke
if name in get_api_names():
return api
else:
raise ValueError(f'API {name} not compiled in')
def get_devices(api=None, **kwargs):
devices = {}
rtapi = _get_api_id(api)
mi = rtmidi.MidiIn(rtapi=rtapi)
mo = rtmidi.MidiOut(rtapi=rtapi)
input_names = mi.get_ports()
output_names = mo.get_ports()
for name in input_names + output_names:
if name not in devices:
devices[name] = {
'name': name,
'is_input': name in input_names,
'is_output': name in output_names,
}
mi.delete()
mo.delete()
return list(devices.values())
def get_api_names():
return [_api_to_name[n] for n in rtmidi.get_compiled_api()]
def _open_port(rt, name=None, client_name=None, virtual=False, api=None):
if client_name is not None:
virtual = True
if virtual:
if name is None:
raise OSError('virtual port must have a name')
rt.open_virtual_port(name)
return name
if api == 'LINUX_ALSA':
name = expand_alsa_port_name(rt.get_ports(), name)
port_names = rt.get_ports()
if len(port_names) == 0:
raise OSError('no ports available')
if name is None:
name = port_names[0]
port_id = 0
elif name in port_names:
port_id = port_names.index(name)
else:
raise OSError(f'unknown port {name!r}')
try:
rt.open_port(port_id)
except RuntimeError as err:
raise OSError(*err.args) from err
return name
class PortCommon:
def _close(self):
self._rt.close_port()
self._rt.delete()
class Input(PortCommon, ports.BaseInput):
_locking = False
def _open(self, client_name=None, virtual=False,
api=None, callback=None, **kwargs):
self.closed = True
self._callback_lock = threading.RLock()
self._queue = ParserQueue()
rtapi = _get_api_id(api)
self._rt = rtmidi.MidiIn(name=client_name, rtapi=rtapi)
self.api = _api_to_name[self._rt.get_current_api()]
self._device_type = f'RtMidi/{self.api}'
self.name = _open_port(self._rt, self.name, client_name=client_name,
virtual=virtual, api=self.api)
self._rt.ignore_types(False, False, True)
self.closed = False
# We need to do this last when everything is set up.
self.callback = callback
def _close(self):
# Deregister the callback before closing the port
# to prevent crashing another thread.
self.callback = None
super()._close()
# We override receive() and poll() instead of _receive() and
# _poll() to bypass locking.
def receive(self, block=True):
if block:
return self._queue.get()
else:
return self._queue.poll()
def poll(self):
return self._queue.poll()
receive.__doc__ = ports.BaseInput.receive.__doc__
poll.__doc__ = ports.BaseInput.poll.__doc__
@property
def callback(self):
return self._callback
@callback.setter
def callback(self, func):
with self._callback_lock:
# Make sure the callback doesn't run while were swapping it out.
self._rt.cancel_callback()
if func:
# Make sure the callback gets all the queued messages.
for msg in self._queue.iterpoll():
func(msg)
self._callback = func
self._rt.set_callback(self._callback_wrapper)
def _callback_wrapper(self, msg_data, data):
try:
msg = Message.from_bytes(msg_data[0])
except ValueError:
# Ignore invalid message.
return
(self._callback or self._queue.put)(msg)
class Output(PortCommon, ports.BaseOutput):
_locking = False
def _open(self, client_name=None, virtual=False,
api=None, callback=None, **kwargs):
self.closed = True
self._send_lock = threading.RLock()
rtapi = _get_api_id(api)
self._rt = rtmidi.MidiOut(name=client_name, rtapi=rtapi)
self.api = _api_to_name[self._rt.get_current_api()]
self._device_type = f'RtMidi/{self.api}'
self.name = _open_port(self._rt, self.name, client_name=client_name,
virtual=virtual, api=self.api)
self.closed = False
# We override send() instead of _send() to bypass locking.
def send(self, msg):
"""Send a message on the port."""
with self._send_lock:
self._rt.send_message(msg.bytes())
send.__doc__ = ports.BaseOutput.send.__doc__
|