From 50ae6f1fdd4fd9e880435ff7e831f7461cb5302e Mon Sep 17 00:00:00 2001 From: sbahling Date: Sun, 14 Oct 2018 21:47:05 +0200 Subject: Initial commit --- tascam-fw-osc.py | 832 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 832 insertions(+) create mode 100644 tascam-fw-osc.py (limited to 'tascam-fw-osc.py') diff --git a/tascam-fw-osc.py b/tascam-fw-osc.py new file mode 100644 index 0000000..827d399 --- /dev/null +++ b/tascam-fw-osc.py @@ -0,0 +1,832 @@ +#!/usr/bin/env python3 +""" + Open Sound Control send/recieve daemon for Tascam Firewire control surface + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + :copyright: Copyright (c) 2012-2014 Scott Bahling + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License version 2 as + published by the Free Software Foundation. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program (see the file COPYING); if not, write to the + Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + :license: GPL-2.0, see COPYING for details +""" + +import argparse +import string +import re +import pyautogui +from pathlib import Path +from pythonosc import dispatcher +from pythonosc import osc_server +from pythonosc import udp_client + +import gi + +gi.require_version('Hinawa', '2.0') +from gi.repository import Hinawa # noqa: E402 +from hinawa_utils.tscm.tscm_console_unit import TscmConsoleUnit # noqa: E402 + + +keymap = {'CTRL': 'ctrl', + 'ALT': 'alt', + 'SHIFT': 'shift', + } + +osc = None + +osc_addrs = {'STOP': '/transport_stop', + 'PLAY': '/transport_play', + 'F.FWD': '/ffwd', + 'REW': '/rewind', + 'REC': '/rec_enable_toggle', + } + +control_state = {} +button_state = {} + +re_strip_num = re.compile('.*([1-9])') + +current_bank = 1 +more_banks_up = False +more_banks_down = False + +class StripState(): + + def __init__(self): + self.mute = False + self.solo = False + self.select = False + self.recenable = False + self.pan = 0.5 + self.fader_touch = False + self.fader = 0.0 + self.name = None + + +strip_states = [] +for strip in range(0, 9): + strip_states.append(StripState()) + + +def check_bitR2L(data, bit): + return bool(data & (0b1 << bit)) + + +def handle_master_fader(unit, flags): + addr = '/master/fader' + pos = (flags & 0xffff) / 1023 + if pos != control_state.get('Master Fader', 0): + print('{}: {}'.format('Master', pos)) + if strip_states[0].fader_touch: + osc.send_message(addr, pos) + + +def handle_strip_fader(unit, index, flags): + addr = '/strip/fader' + strip1 = (index * 2 + 1) + strip2 = (index * 2 + 2) + fader1 = 'Strip %s Fader' % strip1 + fader2 = 'Strip %s Fader' % strip2 + pos1 = (flags & 0xffff) / 1023 + pos2 = (flags >> 0x10) / 1023 + + if pos1 != strip_states[strip1].fader: + print('{}: {}'.format(fader1, pos1)) + if strip_states[strip1].fader_touch: + osc.send_message(addr, (strip1, pos1)) + + if pos2 != strip_states[strip2].fader: + print('{}: {}'.format(fader2, pos2)) + if strip_states[strip2].fader_touch: + osc.send_message(addr, (strip2, pos2)) + + +def roll_over_delta(delta, ceiling=0xffff): + + print(delta) + if delta > ceiling - 10: + return delta - (ceiling + 1) + if delta < -ceiling + 10: + return delta + (ceiling + 1) + return delta + + +def handle_encoder_button(index, flags, bit, bitstate, control, *args): + if bitstate: + return + + encoder_mode = control_state.get('encoder_mode', None) + print(encoder_mode) + if encoder_mode == control: + return + + control_state[control] = 1 + if encoder_mode: + unit.leds.turn_off(encoder_mode) + control_state[encoder_mode] = 0 + unit.leds.turn_on(control) + control_state['encoder_mode'] = control + + +def send_pan(strip, delta): + addr = '/strip/pan_stereo_position' + pan = strip_states[strip].pan + delta * 0.02 + if pan < 0: + pan = 0 + if pan > 1.0: + pan = 1.0 + osc.send_message(addr, (strip, pan)) + + +def recv_pan(strip, pan): + print('Pan: {} {}'.format(strip, pan)) + strip_states[strip].pan = pan + + +def handle_encoder(unit, index, flags): + strip1 = (index * 2 - 19) + strip2 = (index * 2 - 18) + enc1 = 'Strip %s Encoder' % strip1 + enc2 = 'Strip %s Encoder' % strip2 + val1 = flags & 0xffff + val2 = flags >> 0x10 + + delta1 = roll_over_delta(val1 - control_state.get(enc1, val1)) + delta2 = roll_over_delta(val2 - control_state.get(enc2, val2)) + + if delta1: + if control_state.get('PAN', 0): + send_pan(strip1, delta1) + + if delta2: + if control_state.get('PAN', 0): + send_pan(strip2, delta2) + + control_state[enc1] = val1 + control_state[enc2] = val2 + + +def handle_encoder_inc(index, flags, bit, bitstate, control, encoder, sense): + on = control_state.get(control, 0) + + high = bool(bitstate) + low = not high + + print(sense, on, int(low)) + if (low and on) or (high and not on): + print('no change') + return + + if sense == 'a': + complement = control_state.get(control.replace('a', 'b')) + else: + complement = control_state.get(control.replace('b', 'a')) + + if low: + control_state[control] = 1 + if complement: + delta = 0.02 + else: + delta = -0.02 + else: + control_state[control] = 0 + if not complement: + delta = 0.02 + else: + delta = -0.02 + + if sense == 'a': + delta = delta * -1 + + +def handle_eq_encoder(unit, index, flags): + val1 = flags & 0xffff + val2 = flags >> 0x10 + + if index == 14: + enc1 = 'Gain Encoder' + enc2 = 'Freq Encoder' + + if index == 15: + enc1 = 'Q Encoder' + enc2 = 'Data Wheel' + + # delta1 = roll_over_delta(val1 - control_state.get(enc1, val1)) + delta2 = roll_over_delta(val2 - control_state.get(enc2, val2)) + + if val1 != control_state.get(enc1, 0): + strip_states[strip].mute = 0 + print('{}: {}'.format(enc1, val1)) + control_state[enc1] = val1 + + if val2 != control_state.get(enc2, 0): + print('{}: {}'.format(enc2, val2)) + control_state[enc2] = val2 + if enc2 == 'Data Wheel': + if button_state.get('SHIFT', 0): + amount = 0.01 + elif button_state.get('CTRL', 0): + amount = 0.001 + else: + amount = 0.1 + osc.send_message('/jog', delta2 * amount) + + +def handle_strip_sel(index, flags, bits, bitstate, control, strip): + if bitstate: + return + + print('handle_strip_sel', strip) + if button_state.get('REC ENABLE', 0): + if strip_states[strip].recenable: + osc.send_message('/strip/recenable', (strip, 0)) + else: + osc.send_message('/strip/recenable', (strip, 1)) + + +def handle_strip_mute(index, flags, bits, bitstate, control, strip): + high = bool(bitstate) + + # only react to button press + if high: + return + + if strip_states[strip].mute: + strip_states[strip].mute = False + osc.send_message('/strip/mute', (strip, 0)) + else: + strip_states[strip].mute = True + osc.send_message('/strip/mute', (strip, 1)) + + +def handle_strip_solo(index, flags, bits, bitstate, control, *args): + high = bool(bitstate) + + # only react to button press + if high: + return + + try: + strip = int(re_strip_num.match(control).group(1)) + except Exception as e: + raise e + + if strip_states[strip].solo: + strip_states[strip].solo = False + osc.send_message('/strip/solo', (strip, 0)) + else: + strip_states[strip].solo = True + osc.send_message('/strip/solo', (strip, 1)) + + +def handle_button(index, flags, bit, bitstatus, control, *args): + if bitstatus: + print('Button Release: %s' % control) + else: + print('Button Press: %s' % control) + + +def handle_arrow_button(index, flags, bit, bitstatus, control, *args): + if bitstatus: + return + + key = keymap.get(control.lower(), control.lower()) + pyautogui.press(key) + + +def handle_mod_button(index, flags, bit, bitstatus, control, *args): + key = keymap.get(control, None) + if key is None: + return + + if bitstatus: + pyautogui.keyUp(key) + else: + pyautogui.keyDown(key) + + +def handle_computer_button(index, flags, bit, bitstate, control, *args): + if bitstate: + return + osc.send_message('/set_surface', (8, 7, 19, 1, 8, 11)) + + +def handle_clr_solo_button(index, flags, bit, bitstate, control, *args): + if bitstate: + return + osc.send_message('/cancel_all_solos', 1) + + +def handle_loop_button(index, flags, bit, bitstate, control, *args): + if bitstate: + return + if control_state.get(control, 0): + print('******* loop on') + osc.send_message('/loop_toggle', 0) + else: + print('******* loop off') + osc.send_message('/loop_toggle', 1) + + +def handle_transport(index, flags, bit, bitstate, control, *args): + if bitstate: + return + + addr = osc_addrs.get(control, None) + if addr: + osc.send_message(addr, 1) + + +def default_handler(index, flags, bit, bitstate, control, *args): + print('no handler for %s' % control) + + +def handle_fader_touch(index, flags, bit, bitstate, control, strip): + + if not bitstate: + strip_states[strip].fader_touch = True + else: + strip_states[strip].fader_touch = False + + +def handle_bank_switch(index, flags, bit, bitstate, control, direction): + # only handle button press + if bitstate: + return + + print(direction, more_banks_up, more_banks_down) + if direction > 0 and more_banks_up: + print('calling /bank_up 1') + osc.send_message('/bank_up', 1) + elif direction < 0 and more_banks_down: + print('calling /bank_down 1') + osc.send_message('/bank_down', 1) + + +def handle_nudge(index, flags, bit, bitstate, control, direction): + # only handle button press + if bitstate: + return + + print(direction) + if direction > 0: + osc.send_message('/access_action', 'Common/nudge-next-forward') + else: + osc.send_message('/access_action', 'Common/nudge-next-backward') + + +control_flags = {5: [None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + None, + ('Fader1 Touch', handle_fader_touch, 1), + ('Fader2 Touch', handle_fader_touch, 2), + ('Fader3 Touch', handle_fader_touch, 3), + ('Fader4 Touch', handle_fader_touch, 4), + ('Fader5 Touch', handle_fader_touch, 5), + ('Fader6 Touch', handle_fader_touch, 6), + ('Fader7 Touch', handle_fader_touch, 7), + ('Fader8 Touch', handle_fader_touch, 8), + ('Fader9 Touch', handle_fader_touch, 0), + None, + None, + None, + None, + None, + None, + None, + ], + 6: [('enc1a', None, 1, 'a'), + ('enc1b', None, 1, 'b'), + ('enc3a', None, 2, 'a'), + ('enc3b', None, 2, 'b'), + ('enc5a', None, 3, 'a'), + ('enc5b', None, 3, 'b'), + ('enc7a', None, 4, 'a'), + ('enc7b', None, 4, 'b'), + ('enc2a', None, 5, 'a'), + ('enc2b', None, 5, 'b'), + ('enc4a', None, 6, 'a'), + ('enc4b', None, 6, 'b'), + ('enc6a', None, 7, 'a'), + ('enc6b', None, 7, 'b'), + ('enc8a', None, 8, 'a'), + ('enc8b', None, 8, 'b'), + ('Strip1 SEL', handle_strip_sel, 1), + ('Strip2 SEL', handle_strip_sel, 2), + ('Strip3 SEL', handle_strip_sel, 3), + ('Strip4 SEL', handle_strip_sel, 4), + ('Strip5 SEL', handle_strip_sel, 5), + ('Strip6 SEL', handle_strip_sel, 6), + ('Strip7 SEL', handle_strip_sel, 7), + ('Strip8 SEL', handle_strip_sel, 8), + ('Strip1 SOLO', handle_strip_solo, 1), + ('Strip2 SOLO', handle_strip_solo, 2), + ('Strip3 SOLO', handle_strip_solo, 3), + ('Strip4 SOLO', handle_strip_solo, 4), + ('Strip5 SOLO', handle_strip_solo, 5), + ('Strip6 SOLO', handle_strip_solo, 6), + ('Strip7 SOLO', handle_strip_solo, 7), + ('Strip8 SOLO', handle_strip_solo, 8), + ], + 7: [('Strip1 MUTE', handle_strip_mute, 1), + ('Strip2 MUTE', handle_strip_mute, 2), + ('Strip3 MUTE', handle_strip_mute, 3), + ('Strip4 MUTE', handle_strip_mute, 4), + ('Strip5 MUTE', handle_strip_mute, 5), + ('Strip6 MUTE', handle_strip_mute, 6), + ('Strip7 MUTE', handle_strip_mute, 7), + ('Strip8 MUTE', handle_strip_mute, 8), + ('AUX5', handle_encoder_button), + ('AUX7', handle_encoder_button), + ('AUX6', handle_encoder_button), + ('AUX8', handle_encoder_button), + None, + None, + None, + None, + ('FLIP', handle_button), + ('AUX1', handle_encoder_button), + ('AUX3', handle_encoder_button), + ('PAN', handle_encoder_button), + ('AUX2', handle_encoder_button), + ('AUX4', handle_encoder_button), + None, + None, + ('Control Panel', handle_button), + ('F1', handle_button), + ('ALL SAFE', handle_button), + ('F5', handle_button), + ('CUT', handle_button), + ('COPY', handle_button), + ('ALT', handle_mod_button), + ('SHIFT', handle_mod_button), + ], + 8: [('F2', handle_button), + ('CLR SOLO', handle_clr_solo_button), + ('LOOP', handle_loop_button), + ('DEL', handle_button), + ('PASTE', handle_button), + ('UNDO', handle_button), + ('CTRL', handle_mod_button), + ('Foot Switch', handle_button), + ('Gain Enc A', None), + ('Gain Enc B', None), + ('Q Enc A', None), + ('Q Enc B', None), + None, + None, + None, + None, + ('Freq Enc A', None), + ('Freq Enc B', None), + None, + None, + None, + None, + None, + None, + None, + ('COMPUTER', handle_computer_button), + None, + None, + ('CLOCK', handle_button), + ('ROUTE', handle_button), + None, + None, + ], + 9: [('F7', handle_button), + ('F8', handle_button), + ('F9', handle_button), + ('F10', handle_button), + ('READ', handle_button), + ('WRT', handle_button), + ('TCH', handle_button), + ('LATCH', handle_button), + ('HIGH', handle_button), + ('HI-MID', handle_button), + ('LOW-MID', handle_button), + ('LOW', handle_button), + ('UP', handle_arrow_button), + ('LEFT', handle_arrow_button), + ('DOWN', handle_arrow_button), + ('RIGHT', handle_arrow_button), + ('REC ENABLE', handle_button), + ('NUDGE LEFT', handle_nudge, -1), + ('NUDGE RIGHT', handle_nudge, 1), + ('BANK LEFT', handle_bank_switch, -1), + ('BANK RIGHT', handle_bank_switch, 1), + ('LOCATE LEFT', handle_button), + ('LOCATE RIGHT', handle_button), + ('SHTL', handle_button), + ('SET', handle_button), + ('IN', handle_button), + ('OUT', handle_button), + ('REW', handle_transport), + ('F.FWD', handle_transport), + ('STOP', handle_transport), + ('PLAY', handle_transport), + ('REC', handle_transport), + ] + } + + +def handle_bit_flags(unit, index, flags): + for bit in range(32): + high = check_bitR2L(flags, bit) + low = not high + command_map = control_flags[index][bit] + if command_map is None or command_map[1] is None: + continue + control = command_map[0] + on = control_state.get(control, 0) or button_state.get(control, 0) + button_state[control] = int(low) + + if (low and on) or (high and not on): + continue + + bitstate = int(high) + + print(command_map) + handler = command_map[1] + args = (None,) + if len(command_map) > 2: + args = command_map[2:] + + try: + handler(index, flags, bit, bitstate, control, *args) + except Exception as e: + print(e) + + +def handle_control(unit, index, flags): + + print('{0:02d}: {1:08x}'.format(index, flags)) + if index in [0, 1, 2, 3]: + handle_strip_fader(unit, index, flags) + return + + if index == 4: + handle_master_fader(unit, flags) + return + + if index in [5, 6, 7, 8, 9]: + handle_bit_flags(unit, index, flags) + return + + if index in [10, 11, 12, 13]: + handle_encoder(unit, index, flags) + return + + if index in [14, 15]: + handle_eq_encoder(unit, index, flags) + + +def _check_hexadecimal(literal): + if literal.find('0x') == 0: + literal = literal[2:] + if len(literal) != 16: + return False + for character in literal: + if character not in string.hexdigits: + return False + else: + return True + + +def _seek_snd_unit_from_guid(guid): + for fullpath in Path('/dev/snd').glob('hw*'): + fullpath = str(fullpath) + try: + unit = Hinawa.SndUnit() + unit.open(fullpath) + if unit.get_property('guid') == guid: + return fullpath + except Exception as e: + pass + finally: + del unit + return None + + +def seek_snd_unit_path(card_id): + # Assume as sound card number if it's digit literal. + if card_id.isdigit(): + return '/dev/snd/hwC{0}D0'.format(card_id) + # Assume as GUID on IEEE 1394 bus if it's hexadecimal literal. + elif _check_hexadecimal(card_id): + return _seek_snd_unit_from_guid(int(card_id, base=16)) + return None + + +def print_default_handler(addr, *args): + print(addr, args) + + +def strip_fader_handler(addr, args, ssid, pos): + unit = args[0] + strip = int(ssid) + print('fader_handler', addr, ssid, pos) + pos = pos * 1023 + if strip_states[strip].name != ' ': + unit.strips[strip].fader.set_position(pos) + strip_states[strip].fader = pos + + +def strip_mute_handler(addr, args, ssid, state): + unit = args[0] + strip = int(ssid) + print('mute_handler', strip, state) + if strip_states[strip].name == ' ': + return + if state: + unit.strips[int(ssid)].mute_led.turn_on() + strip_states[int(ssid)].mute = True + else: + unit.strips[int(ssid)].mute_led.turn_off() + strip_states[int(ssid)].mute = False + + +def strip_solo_handler(addr, args, ssid, state): + unit = args[0] + strip = int(ssid) + print('solo_handler', strip, state) + if strip_states[strip].name == ' ': + return + if state: + unit.strips[strip].solo_led.turn_on() + strip_states[strip].solo = True + else: + unit.strips[strip].solo_led.turn_off() + strip_states[strip].solo = False + + +def strip_recenable_handler(addr, args, ssid, state): + unit = args[0] + strip = int(ssid) + print('recenable_handler', strip, state) + if strip_states[strip].name == ' ': + return + if state: + unit.strips[strip].rec_led.turn_on() + strip_states[strip].recenable = True + else: + unit.strips[strip].rec_led.turn_off() + strip_states[strip].recenable = False + + +def loop_toggle_handler(addr, state): + print(addr, state) + if state: + control_state['LOOP'] = 1 + unit.leds.loop.turn_on() + else: + control_state['LOOP'] = 0 + unit.leds.loop.turn_off() + + +def transport_stop_handler(addr, args, state): + print(addr, args, state) + unit = args[0] + if state: + unit.leds.stop.turn_on() + else: + unit.leds.stop.turn_off() + + +def transport_play_handler(addr, args, state): + print(addr, args, state) + unit = args[0] + if state: + unit.leds.play.turn_on() + else: + unit.leds.play.turn_off() + + +def ffwd_handler(addr, args, state): + unit = args[0] + if state: + unit.leds.f_fwd.turn_on() + else: + unit.leds.f_fwd.turn_off() + + +def rewind_handler(addr, args, state): + unit = args[0] + if state: + unit.leds.rew.turn_on() + else: + unit.leds.rew.turn_off() + + +def rec_enable_toggle_handler(addr, args, state): + unit = args[0] + if state: + unit.leds.rec.turn_on() + else: + unit.leds.rec.turn_off() + + +def master_fader_handler(addr, args, pos): + unit = args[0] + print('master_fader_handler', pos) + unit.master_fader.set_position(1023 * pos) + + +def pan_stereo_position_handler(addr, pos, pan): + recv_pan(pos, pan) + + +def strip_name_handler(addr, ssid, name): + strip_states[int(ssid)].name = name + + +def bank_up_handler(addr, more_up): + print(addr, more_up) + global more_banks_up + more_banks_up = bool(more_up) + + +def bank_down_handler(addr, more_down): + print(addr, more_down) + global more_banks_down + more_banks_down = bool(more_down) + + +def init_console(): + handle_encoder_button(1, 1, 1, 1, 'PAN', 1) + + +if __name__ == "__main__": + + parser = argparse.ArgumentParser() + parser.add_argument("--card", default="1", + help="number of the ALSA sound card") + parser.add_argument("--listen-ip", default="127.0.0.1", + help="The ip to listen on") + parser.add_argument("--listen-port", type=int, default=5005, + help="The port to listen on") + parser.add_argument("--ip", default="127.0.0.1", + help="The ip of the OSC server") + parser.add_argument("--port", type=int, default=3819, + help="The port the OSC server is listening on") + args = parser.parse_args() + + fullpath = seek_snd_unit_path(args.card) + if fullpath: + unit = TscmConsoleUnit(fullpath) + else: + exit() + + unit.connect('control', handle_control) + + osc = udp_client.SimpleUDPClient(args.ip, args.port) + + init_console() + + dispatcher = dispatcher.Dispatcher() + dispatcher.map("/loop_toggle", loop_toggle_handler) + dispatcher.map("/transport_stop", transport_stop_handler, unit) + dispatcher.map("/transport_play", transport_play_handler, unit) + dispatcher.map("/ffwd", ffwd_handler, unit) + dispatcher.map("/rewind", rewind_handler, unit) + dispatcher.map("/rec_enable_toggle", rec_enable_toggle_handler, unit) + dispatcher.map('/strip/fader', strip_fader_handler, unit) + dispatcher.map('/strip/mute', strip_mute_handler, unit) + dispatcher.map('/strip/solo', strip_solo_handler, unit) + dispatcher.map('/strip/recenable', strip_recenable_handler, unit) + dispatcher.map('/master/fader', master_fader_handler, unit) + dispatcher.map('/strip/pan_stereo_position', pan_stereo_position_handler) + dispatcher.map('/strip/name', strip_name_handler) + dispatcher.map('/bank_up', bank_up_handler) + dispatcher.map('/bank_down', bank_down_handler) + dispatcher.set_default_handler(print_default_handler) + + server = osc_server.ThreadingOSCUDPServer((args.listen_ip, + args.listen_port), + dispatcher + ) + + print("Serving on {}".format(server.server_address)) + server.serve_forever() -- cgit v1.2.3