def __init__(self):
logging.basicConfig(level=(logging.DEBUG if LOG else logging.WARNING))
self.prefs = UserPreferences()
self.player = Player()
self.recorder = Recorder()
self.recordhandle = None
self.screenshot_generator = ScreenshotGenerator()
self.websockets = []
# Used in mod-app to know when the current pedalboard changed
self.pedalboard_changed_callback = lambda ok, bundlepath, title: None
# Try to open real HMI
hmiOpened = False
if not DEV_HMI:
self.hmi = HMI(HMI_SERIAL_PORT, HMI_BAUD_RATE, HMI_TIMEOUT,
self.hmi_initialized_cb, self.hmi_reinit_cb)
hmiOpened = self.hmi.sp is not None
#print("Using HMI =>", hmiOpened)
if not hmiOpened:
self.hmi = FakeHMI(self.hmi_initialized_cb)
print("Using FakeHMI =>", self.hmi)
self.host = Host(self.hmi, self.prefs, self.msg_callback)
def __init__(self, hmi, msg_callback):
Host.__init__(self, hmi, msg_callback)
self.carla = CarlaHostDLL("/usr/lib/carla/libcarla_standalone2.so")
self.carla.set_engine_callback(self.carla_callback)
self.carla.set_engine_option(ENGINE_OPTION_PREFER_PLUGIN_BRIDGES, 0, "")
self.carla.set_engine_option(ENGINE_OPTION_PREFER_UI_BRIDGES, 0, "")
self.carla.set_engine_option(ENGINE_OPTION_PROCESS_MODE, ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS, "")
self.carla.set_engine_option(ENGINE_OPTION_TRANSPORT_MODE, ENGINE_TRANSPORT_MODE_JACK, "")
self.carla.set_engine_option(ENGINE_OPTION_PATH_BINARIES, 0, "/usr/lib/carla/")
self.carla.set_engine_option(ENGINE_OPTION_PATH_RESOURCES, 0, "/usr/share/carla/resources/")
self.carlatimer = ioloop.PeriodicCallback(self.carlatimer_callback, 300)
self._client_id_system = -1
self._plugins_info = []
class Session(object):
def __init__(self):
logging.basicConfig(level=(logging.DEBUG if LOG else logging.WARNING))
self.prefs = UserPreferences()
self.player = Player()
self.recorder = Recorder()
self.recordhandle = None
self.screenshot_generator = ScreenshotGenerator()
self.websockets = []
# Used in mod-app to know when the current pedalboard changed
self.pedalboard_changed_callback = lambda ok, bundlepath, title: None
# Try to open real HMI
hmiOpened = False
if not DEV_HMI:
self.hmi = HMI(HMI_SERIAL_PORT, HMI_BAUD_RATE, HMI_TIMEOUT,
self.hmi_initialized_cb, self.hmi_reinit_cb)
hmiOpened = self.hmi.sp is not None
#print("Using HMI =>", hmiOpened)
if not hmiOpened:
self.hmi = FakeHMI(self.hmi_initialized_cb)
print("Using FakeHMI =>", self.hmi)
self.host = Host(self.hmi, self.prefs, self.msg_callback)
def signal_save(self):
# reuse HMI function
self.host.hmi_save_current_pedalboard(lambda r: None)
def signal_device_updated(self):
self.msg_callback("cc-device-updated")
def signal_disconnect(self):
sockets = self.websockets
self.websockets = []
for ws in sockets:
ws.write_message("stop")
ws.close()
self.host.end_session(lambda r: None)
def get_hardware_actuators(self):
return self.host.addressings.get_actuators()
def wait_for_hardware_if_needed(self, callback):
return self.host.addressings.wait_for_cc_if_needed(callback)
# -----------------------------------------------------------------------------------------------------------------
# App utilities, needed only for mod-app
def setupApp(self, pedalboardChangedCallback):
self.pedalboard_changed_callback = pedalboardChangedCallback
def reconnectApp(self):
if self.host.readsock is not None:
self.host.readsock.close()
self.host.readsock = None
if self.host.writesock is not None:
self.host.writesock.close()
self.host.writesock = None
self.host.open_connection_if_needed(None)
# -----------------------------------------------------------------------------------------------------------------
# Initialization
@gen.coroutine
def hmi_initialized_cb(self):
self.hmi.initialized = not self.hmi.isFake()
uiConnected = bool(len(self.websockets) > 0)
yield gen.Task(self.host.initialize_hmi, uiConnected)
# This is very nasty, sorry
def hmi_reinit_cb(self):
if not os.path.exists("/usr/bin/hmi-reset"):
return
# stop websockets
self.hmi.initialized = False
self.signal_disconnect()
# restart hmi
os.system("/usr/bin/hmi-reset; /usr/bin/sleep 3")
# reconnect to newly started hmi
self.hmi = HMI(HMI_SERIAL_PORT, HMI_BAUD_RATE, HMI_TIMEOUT,
self.hmi_initialized_cb, self.hmi_reinit_cb)
self.host.reconnect_hmi(self.hmi)
# -----------------------------------------------------------------------------------------------------------------
# Webserver callbacks, called from the browser (see webserver.py)
# These will be called as a reponse to an action in the browser.
# A callback must always be used unless specified otherwise.
# Add a new plugin, starts enabled (ie, not bypassed)
def web_add(self, instance, uri, x, y, callback):
self.host.add_plugin(instance, uri, x, y, callback)
# Remove a plugin
def web_remove(self, instance, callback):
self.host.remove_plugin(instance, callback)
# Address a plugin parameter
def web_parameter_address(self, port, actuator_uri, label, minimum,
maximum, value, steps, tempo, dividers, page,
subpage, coloured, momentary, operational_mode,
callback):
instance, portsymbol = port.rsplit("/", 1)
extras = {
'tempo': tempo,
'dividers': dividers,
'page': page,
'subpage': subpage,
'coloured': coloured,
'momentary': momentary,
'operational_mode': operational_mode,
}
self.host.address(instance, portsymbol, actuator_uri, label, minimum,
maximum, value, steps, extras, callback)
def web_set_sync_mode(self, mode, callback):
self.host.set_sync_mode(mode, True, False, True, callback)
# Connect 2 ports
def web_connect(self, port_from, port_to, callback):
self.host.connect(port_from, port_to, callback)
# Disconnect 2 ports
def web_disconnect(self, port_from, port_to, callback):
self.host.disconnect(port_from, port_to, callback)
# Save the current pedalboard
# returns saved bundle path
def web_save_pedalboard(self, title, asNew, callback):
bundlepath, newPB = self.host.save(title, asNew, callback)
self.pedalboard_changed_callback(True, bundlepath, title)
if self.hmi.initialized and self.host.descriptor.get(
'hmi_set_pb_name', False):
self.hmi_set_pb_name(title)
self.screenshot_generator.schedule_screenshot(bundlepath)
return bundlepath, newPB
# Get list of Hardware MIDI devices
# returns (devsInUse, devList, names, midi_aggregated_mode)
def web_get_midi_device_list(self):
return self.host.get_midi_ports()
# Set the selected MIDI devices to @a newDevs
# Will remove or add new JACK ports as needed
def web_set_midi_devices(self, newDevs, midi_aggregated_mode):
return self.host.set_midi_devices(newDevs, midi_aggregated_mode)
# Send a ping to HMI and Websockets
def web_ping(self, callback):
if self.hmi.initialized:
self.hmi.ping(callback)
else:
callback(False)
self.msg_callback("ping")
def web_cv_addressing_plugin_port_add(self, uri, name):
return self.host.cv_addressing_plugin_port_add(uri, name)
def web_cv_addressing_plugin_port_remove(self, uri, callback):
self.host.cv_addressing_plugin_port_remove(uri, callback)
# A new webbrowser page has been open
# We need to cache its socket address and send any msg callbacks to it
def websocket_opened(self, ws, callback):
def ready(_):
self.websockets.append(ws)
self.host.open_connection_if_needed(ws)
callback(True)
# if this is the 1st socket, start ui session
if len(self.websockets) == 0:
self.host.start_session(ready)
else:
ready(True)
# Webbrowser page closed
def websocket_closed(self, ws, callback):
try:
self.websockets.remove(ws)
except ValueError:
pass
# if this is the last socket, end ui session
if len(self.websockets) == 0:
self.host.end_session(callback)
else:
callback(True)
# -----------------------------------------------------------------------------------------------------------------
# Start recording
def web_recording_start(self):
self.player.stop()
self.recorder.start()
# Stop recording
def web_recording_stop(self):
if self.recordhandle is not None:
self.recordhandle.close()
self.recordhandle = self.recorder.stop(True)
# Delete previous recording, if any
def web_recording_delete(self):
self.player.stop()
if self.recordhandle is not None:
self.recordhandle.close()
self.recordhandle = None
# Return recording data
def web_recording_download(self):
if self.recordhandle is None:
return ""
self.recordhandle.seek(0)
return self.recordhandle.read()
# Playback of previous recording started
def web_playing_start(self, callback):
if self.recordhandle is None:
self.recordhandle = self.recorder.stop(True)
def stop():
self.host.unmute()
callback()
def schedule_stop():
IOLoop.instance().add_timeout(timedelta(seconds=0.5), stop)
self.host.mute()
self.player.play(self.recordhandle, schedule_stop)
# Playback stopped
def web_playing_stop(self):
self.player.stop()
# -----------------------------------------------------------------------------------------------------------------
# Websocket funtions, called when receiving messages from socket (see webserver.py)
# There are no callbacks for these functions.
# Set a plugin parameter
# We use ":bypass" symbol for on/off state
def ws_parameter_set(self, port, value, ws):
instance, portsymbol = port.rsplit("/", 1)
if portsymbol == ":bypass":
bvalue = value >= 0.5
self.host.bypass(instance, bvalue, None)
else:
self.host.param_set(port, value, None)
self.msg_callback_broadcast(
"param_set %s %s %f" % (instance, portsymbol, value), ws)
# LV2 patch support
def ws_patch_get(self, instance, uri, ws):
self.host.patch_get(instance, uri, None)
def ws_patch_set(self, instance, uri, valuetype, valuedata, ws):
writable = self.host.patch_set(instance, uri, valuedata, None)
self.msg_callback_broadcast(
"patch_set %s %d %s %c %s" %
(instance, 1 if writable else 0, uri, valuetype, valuedata), ws)
# Set a plugin block position within the canvas
def ws_plugin_position(self, instance, x, y, ws):
self.host.set_position(instance, x, y)
self.msg_callback_broadcast("plugin_pos %s %d %d" % (instance, x, y),
ws)
# set the size of the pedalboard (in 1:1 view, aka "full zoom")
def ws_pedalboard_size(self, width, height):
self.host.set_pedalboard_size(width, height)
# -----------------------------------------------------------------------------------------------------------------
# web session helpers
@gen.coroutine
def hmi_set_pb_name(self, name):
yield gen.Task(self.hmi.set_pedalboard_name, name)
@gen.coroutine
def hmi_set_pb_and_ss_name(self, pbname):
yield gen.Task(self.hmi.set_pedalboard_name, pbname)
if self.host.descriptor.get('hmi_set_ss_name', False):
ssname = self.host.snapshot_name() or DEFAULT_SNAPSHOT_NAME
yield gen.Task(self.hmi.set_snapshot_name, ssname)
# -----------------------------------------------------------------------------------------------------------------
# TODO
# Everything after this line is yet to be documented
def msg_callback(self, msg):
for ws in self.websockets:
ws.write_message(msg)
def msg_callback_broadcast(self, msg, ws2):
for ws in self.websockets:
if ws == ws2: continue
ws.write_message(msg)
def load_pedalboard(self, bundlepath, isDefault):
self.host.send_notmodified("feature_enable processing 0")
title = self.host.load(bundlepath, isDefault)
self.host.send_notmodified("feature_enable processing 1")
if isDefault:
bundlepath = ""
title = ""
if self.hmi.initialized and self.host.descriptor.get(
'hmi_set_pb_name', False):
self.hmi_set_pb_and_ss_name(title or UNTITLED_PEDALBOARD_NAME)
self.pedalboard_changed_callback(True, bundlepath, title)
return title
def reset(self, callback):
logging.debug("SESSION RESET")
self.host.send_notmodified("feature_enable processing 0")
def host_callback(resp):
self.host.send_notmodified("feature_enable processing 1")
callback(resp)
def reset_host(_):
self.host.reset(host_callback)
if self.hmi.initialized:
def set_pb_name(_):
self.hmi.set_pedalboard_name(UNTITLED_PEDALBOARD_NAME,
reset_host)
def clear_ss_name(_):
self.host.hmi_clear_ss_name(set_pb_name)
def clear_hmi(_):
self.hmi.clear(clear_ss_name)
if self.host.descriptor.get("hmi_bank_navigation", False):
self.host.setNavigateWithFootswitches(False, clear_hmi)
else:
clear_hmi(True)
else:
reset_host(True)
# Update the title in HMI
self.pedalboard_changed_callback(True, "", "")
# host commands
def format_port(self, port):
if not 'system' in port and not 'effect' in port:
port = "effect_%s" % port
return port