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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
#!/usr/bin/env python
"""Unit tests for the rtmidi module."""
import time
import unittest
import pytest
import rtmidi
class BaseTests:
NOTE_ON = [0x90, 48, 100]
NOTE_OFF = [0x80, 48, 16]
SYSEX_IDENTITY_REQUEST = [0xF0, 0x7E, 0x7F, 6, 1, 0xF7]
IN_CLIENT_NAME = "RtMidiTestCase In"
OUT_CLIENT_NAME = "RtMidiTestCase Out"
IN_PORT_NAME = 'testin'
OUT_PORT_NAME = 'testout'
DELAY = 0.1
API = rtmidi.API_UNSPECIFIED
def setUp(self):
self.midi_in = rtmidi.MidiIn(rtapi=self.API, name=self.IN_CLIENT_NAME)
self.midi_out = rtmidi.MidiOut(rtapi=self.API, name=self.OUT_CLIENT_NAME)
def tearDown(self):
self.midi_in.close_port()
del self.midi_in
self.midi_out.close_port()
del self.midi_out
def test_is_port_open(self):
assert not self.midi_in.is_port_open()
self.midi_in.open_port(0)
assert self.midi_in.is_port_open()
self.midi_in.close_port()
assert not self.midi_in.is_port_open()
assert not self.midi_out.is_port_open()
self.midi_out.open_port(0)
assert self.midi_out.is_port_open()
self.midi_out.close_port()
assert not self.midi_out.is_port_open()
def test_get_current_api(self):
assert self.midi_in.get_current_api() == self.API
assert self.midi_out.get_current_api() == self.API
class VirtualPortsSupportedTests:
def test_is_port_open_virtual(self):
# virtual ports can't be closed
assert not self.midi_in.is_port_open()
self.midi_in.open_virtual_port()
assert self.midi_in.is_port_open()
self.midi_in.close_port()
assert self.midi_in.is_port_open()
assert not self.midi_out.is_port_open()
self.midi_out.open_virtual_port()
assert self.midi_out.is_port_open()
self.midi_out.close_port()
assert self.midi_out.is_port_open()
def test_send_and_get_message(self):
self.set_up_loopback()
self.midi_out.send_message(self.NOTE_ON)
self.midi_out.send_message(self.NOTE_OFF)
time.sleep(self.DELAY)
event_1 = self.midi_in.get_message()
event_2 = self.midi_in.get_message()
self.assertTrue(isinstance(event_1, tuple))
self.assertTrue(isinstance(event_2, tuple))
self.assertEqual(event_1[0], self.NOTE_ON)
self.assertEqual(event_2[0], self.NOTE_OFF)
def test_send_supports_iterator(self):
self.set_up_loopback()
self.midi_out.send_message(iter(self.NOTE_ON))
time.sleep(self.DELAY)
event = self.midi_in.get_message()
self.assertTrue(isinstance(event, tuple))
self.assertEqual(event[0], self.NOTE_ON)
def test_send_raises_if_message_too_long(self):
self.assertRaises(ValueError, self.midi_out.send_message, [1, 2, 3, 4])
def test_send_raises_if_message_empty(self):
self.assertRaises(ValueError, self.midi_out.send_message, [])
self.assertRaises(ValueError, self.midi_out.send_message, iter([]))
def test_send_accepts_sysex(self):
self.set_up_loopback()
self.midi_in.ignore_types(sysex=False)
self.midi_out.send_message(self.SYSEX_IDENTITY_REQUEST)
time.sleep(self.DELAY)
event = self.midi_in.get_message()
self.assertTrue(isinstance(event, tuple))
self.assertEqual(event[0], self.SYSEX_IDENTITY_REQUEST)
def test_callback(self):
messages = []
def callback(event, data):
messages.append((event[0], data))
self.set_up_loopback()
self.midi_in.set_callback(callback, data=42)
self.midi_out.send_message(self.NOTE_ON)
self.midi_out.send_message(self.NOTE_OFF)
time.sleep(self.DELAY)
self.assertEqual(messages[0], (self.NOTE_ON, 42))
self.assertEqual(messages[1], (self.NOTE_OFF, 42))
self.midi_in.cancel_callback()
messages = []
self.midi_out.send_message(self.NOTE_ON)
self.midi_out.send_message(self.NOTE_OFF)
time.sleep(self.DELAY)
self.assertEqual(messages, [])
def set_up_loopback(self):
# TODO: find better solution than this hack-ish strategy to find out
# the port number of the virtual output port, which we have to use,
# because for ALSA virtual ports, their name includes the client id.
# See: https://github.com/thestk/rtmidi/issues/88
ports_before = self.midi_in.get_ports()
self.midi_out.open_virtual_port(name=self.OUT_PORT_NAME)
ports_after = self.midi_in.get_ports()
self.midi_out_port_name = list(set(ports_after).difference(ports_before))[0]
for portnum, port in enumerate(ports_after):
if port == self.midi_out_port_name:
self.midi_in.open_port(portnum)
break
else:
raise IOError("Could not find MIDI output port.")
class VirtualPortsUnsupportedTests:
def test_is_port_open_virtual(self):
# virtual ports can't be closed
assert not self.midi_in.is_port_open()
self.assertRaises(NotImplementedError, self.midi_in.open_virtual_port)
class SetPortNameSupportedTests:
def test_set_port_name_supported(self):
self.midi_out.open_virtual_port(name=self.OUT_PORT_NAME)
found = False
for port in self.midi_in.get_ports():
client, port = port.split(':', 1)
if client.startswith(self.OUT_CLIENT_NAME) and port.startswith(self.OUT_PORT_NAME):
found = True
break
assert found
self.midi_out.set_port_name("new_port")
found = False
for port in self.midi_in.get_ports():
client, port = port.split(':', 1)
if client.startswith(self.OUT_CLIENT_NAME) and port.startswith("new_port"):
found = True
break
assert found
class SetPortNameUnsupportedTests:
def test_set_port_name_unsupported(self):
self.assertRaises(NotImplementedError, self.midi_out.set_port_name, "new_port")
class SetClientNameSupportedTests:
def test_set_client_name_supported(self):
self.midi_out.open_virtual_port(name=self.OUT_PORT_NAME)
found = False
for port in self.midi_in.get_ports():
client, port = port.split(':', 1)
if client.startswith(self.OUT_CLIENT_NAME) and port.startswith(self.OUT_PORT_NAME):
found = True
break
assert found
self.midi_out.set_client_name("new_client")
found = False
for port in self.midi_in.get_ports():
client, port = port.split(':', 1)
if client.startswith("new_client") and port.startswith(self.OUT_PORT_NAME):
found = True
break
assert found
class SetClientNameUnsupportedTests:
def test_set_client_name_unsupported(self):
self.assertRaises(NotImplementedError, self.midi_out.set_client_name, "new_client")
if rtmidi.API_LINUX_ALSA in rtmidi.get_compiled_api():
class ALSATestCase(BaseTests, SetPortNameSupportedTests, SetClientNameSupportedTests,
VirtualPortsSupportedTests, unittest.TestCase):
API = rtmidi.API_LINUX_ALSA
if rtmidi.API_UNIX_JACK in rtmidi.get_compiled_api():
@pytest.mark.jack
class JACKTestCase(BaseTests, SetPortNameSupportedTests, SetClientNameUnsupportedTests,
VirtualPortsSupportedTests, unittest.TestCase):
API = rtmidi.API_UNIX_JACK
if rtmidi.API_MACOSX_CORE in rtmidi.get_compiled_api():
class CoreMIDITestCase(BaseTests, SetPortNameUnsupportedTests, SetClientNameUnsupportedTests,
VirtualPortsSupportedTests, unittest.TestCase):
API = rtmidi.API_MACOSX_CORE
if rtmidi.API_WINDOWS_MM in rtmidi.get_compiled_api():
class WindowsMMTestCase(BaseTests, SetPortNameUnsupportedTests, SetClientNameUnsupportedTests,
VirtualPortsUnsupportedTests, unittest.TestCase):
API = rtmidi.API_WINDOWS_MM
if __name__ == '__main__':
unittest.main()
|