]> git.immae.eu Git - perso/Immae/Projets/Python/MusicSampler.git/blobdiff - helpers/mapping.py
Add possibility to reload YML config file
[perso/Immae/Projets/Python/MusicSampler.git] / helpers / mapping.py
index 84e99410874a979b7252329c245f152877582586..1256696a8968bfe58ea843ff8a0cfc1874fa0471 100644 (file)
+from kivy.uix.relativelayout import RelativeLayout
+from kivy.properties import NumericProperty, ListProperty, StringProperty
+from kivy.core.window import Window
+from kivy.clock import Clock
+
 import threading
-import pygame
-from .key import *
-
-class Mapping:
-    WIDTH  = 903
-    HEIGHT = 298
-    SIZE   = WIDTH, HEIGHT
-
-    KEYS = [
-        (pygame.K_ESCAPE, 'ESC', 'first',   0, {}),
-
-        (pygame.K_F1,     'F1',  'first', 100, {}),
-        (pygame.K_F2,     'F2',  'first', 150, {}),
-        (pygame.K_F3,     'F3',  'first', 200, {}),
-        (pygame.K_F4,     'F4',  'first', 250, {}),
-
-        (pygame.K_F5,     'F5',  'first', 325, {}),
-        (pygame.K_F6,     'F6',  'first', 375, {}),
-        (pygame.K_F7,     'F7',  'first', 425, {}),
-        (pygame.K_F8,     'F8',  'first', 475, {}),
-
-        (pygame.K_F9,     'F9',  'first', 550, {}),
-        (pygame.K_F10,    'F10', 'first', 600, {}),
-        (pygame.K_F11,    'F11', 'first', 650, {}),
-        (pygame.K_F12,    'F12', 'first', 700, {}),
-
-
-        (178,          '²', 'second',   0, {}),
-        (pygame.K_AMPERSAND,  '&', 'second',  50, {}),
-        (233,          'é', 'second', 100, {}),
-        (pygame.K_QUOTEDBL,   '"', 'second', 150, {}),
-        (pygame.K_QUOTE,      "'", 'second', 200, {}),
-        (pygame.K_LEFTPAREN,  '(', 'second', 250, {}),
-        (pygame.K_MINUS,      '-', 'second', 300, {}),
-        (232,          'è', 'second', 350, {}),
-        (pygame.K_UNDERSCORE, '_', 'second', 400, {}),
-        (231,          'ç', 'second', 450, {}),
-        (224,          'à', 'second', 500, {}),
-        (pygame.K_RIGHTPAREN, ')', 'second', 550, {}),
-        (pygame.K_EQUALS,     '=', 'second', 600, {}),
-
-        (pygame.K_BACKSPACE,  '<-', 'second', 650, { 'width': 98 }),
-
-
-        (pygame.K_TAB,        'tab', 'third',   0, { 'width' : 73 }),
-        (pygame.K_a,          'a',   'third',  75, {}),
-        (pygame.K_z,          'z',   'third', 125, {}),
-        (pygame.K_e,          'e',   'third', 175, {}),
-        (pygame.K_r,          'r',   'third', 225, {}),
-        (pygame.K_t,          't',   'third', 275, {}),
-        (pygame.K_y,          'y',   'third', 325, {}),
-        (pygame.K_u,          'u',   'third', 375, {}),
-        (pygame.K_i,          'i',   'third', 425, {}),
-        (pygame.K_o,          'o',   'third', 475, {}),
-        (pygame.K_p,          'p',   'third', 525, {}),
-        (pygame.K_CARET,      '^',   'third', 575, {}),
-        (pygame.K_DOLLAR,     '$',   'third', 625, {}),
-
-        (pygame.K_RETURN, 'Enter', 'third', 692, { 'width': 56, 'height': 98 }),
-
-        (pygame.K_CAPSLOCK,    'CAPS', 'fourth',  0, { 'width': 88, 'disabled': True }),
-
-        (pygame.K_q,        'q', 'fourth',  90, {}),
-        (pygame.K_s,        's', 'fourth', 140, {}),
-        (pygame.K_d,        'd', 'fourth', 190, {}),
-        (pygame.K_f,        'f', 'fourth', 240, {}),
-        (pygame.K_g,        'g', 'fourth', 290, {}),
-        (pygame.K_h,        'h', 'fourth', 340, {}),
-        (pygame.K_j,        'j', 'fourth', 390, {}),
-        (pygame.K_k,        'k', 'fourth', 440, {}),
-        (pygame.K_l,        'l', 'fourth', 490, {}),
-        (pygame.K_m,        'm', 'fourth', 540, {}),
-        (249,        'ù', 'fourth', 590, {}),
-        (pygame.K_ASTERISK, '*', 'fourth', 640, {}),
-
-
-        (pygame.K_LSHIFT, 'LShift', 'fifth', 0, { 'width': 63, 'disabled': True }),
-
-        (pygame.K_LESS,      '<', 'fifth',  65, {}),
-        (pygame.K_w,         'w', 'fifth', 115, {}),
-        (pygame.K_x,         'x', 'fifth', 165, {}),
-        (pygame.K_c,         'c', 'fifth', 215, {}),
-        (pygame.K_v,         'v', 'fifth', 265, {}),
-        (pygame.K_b,         'b', 'fifth', 315, {}),
-        (pygame.K_n,         'n', 'fifth', 365, {}),
-        (pygame.K_COMMA,     ',', 'fifth', 415, {}),
-        (pygame.K_SEMICOLON, ';', 'fifth', 465, {}),
-        (pygame.K_COLON,     ':', 'fifth', 515, {}),
-        (pygame.K_EXCLAIM,   '!', 'fifth', 565, {}),
-
-        (pygame.K_RSHIFT, 'RShift', 'fifth', 615, { 'width': 133, 'disabled': True }),
-
-        (pygame.K_LCTRL,    'LCtrl',   'sixth',   0, { 'width': 63, 'disabled': True }),
-        (pygame.K_LSUPER,   'LSuper',  'sixth', 115, { 'disabled': True }),
-        (pygame.K_LALT,     'LAlt',    'sixth', 165, { 'disabled': True }),
-        (pygame.K_SPACE,    'Espace',  'sixth', 215, { 'width': 248 }),
-        (pygame.K_MODE,     'AltGr',   'sixth', 465, { 'disabled': True }),
-        (314,        'Compose', 'sixth', 515, { 'disabled': True }),
-        (pygame.K_RCTRL,    'RCtrl',   'sixth', 565, { 'width': 63, 'disabled': True }),
-
-
-        (pygame.K_INSERT,   'ins',  'second', 755, {}),
-        (pygame.K_HOME,     'home', 'second', 805, {}),
-        (pygame.K_PAGEUP,   'pg_u', 'second', 855, {}),
-        (pygame.K_DELETE,   'del',  'third',  755, {}),
-        (pygame.K_END,      'end',  'third',  805, {}),
-        (pygame.K_PAGEDOWN, 'pg_d', 'third',  855, {}),
-
-
-        (pygame.K_UP,       'up',    'fifth',  805, {}),
-        (pygame.K_DOWN,     'down',  'sixth',  805, {}),
-        (pygame.K_LEFT,     'left',  'sixth',  755, {}),
-        (pygame.K_RIGHT,    'right', 'sixth',  855, {}),
+import yaml
+import sys
+from collections import defaultdict
+
+from transitions.extensions import HierarchicalMachine as Machine
+
+from .music_file import MusicFile
+from .mixer import Mixer
+from . import Config, gain, error_print, warn_print
+from .action import Action
+
+class Mapping(RelativeLayout):
+    STATES = [
+        'initial',
+        'configuring',
+        'configured',
+        'loading',
+        'loaded',
+        'failed'
     ]
 
-    def __init__(self, screen, draw_lock):
-        self.draw_lock = draw_lock
-        self.screen = screen
-        self.background = pygame.Surface(self.SIZE).convert()
-        self.background.fill((250, 250, 250))
-        self.keys = {}
-        self.running = []
-        for key in self.KEYS:
-            self.keys[key[0]] = Key(self, self.draw_lock, *key[0:4], **key[4])
-
-    def draw(self):
-        for key_name in self.keys:
-            key = self.keys[key_name]
-            should_redraw_key = key.draw(self.background)
-
-            if should_redraw_key:
-                threading.Thread(name = "MSPollRedraw", target = key.poll_redraw, args = [self.background]).start()
-        self.blit()
-
-    def blit(self):
-        self.draw_lock.acquire()
-        self.screen.blit(self.background, (5, 5))
-        pygame.display.flip()
-        self.draw_lock.release()
-
-    def find_by_key_num(self, key_num):
-        if key_num in self.keys:
-            return self.keys[key_num]
-        return None
+    TRANSITIONS = [
+        {
+            'trigger': 'configure',
+            'source': 'initial',
+            'dest': 'configuring'
+        },
+        {
+            'trigger': 'fail',
+            'source': 'configuring',
+            'dest': 'failed'
+        },
+        {
+            'trigger': 'success',
+            'source': 'configuring',
+            'dest': 'configured',
+            'after': 'load'
+        },
+        {
+            'trigger': 'load',
+            'source': 'configured',
+            'dest': 'loading'
+        },
+        {
+            'trigger': 'fail',
+            'source': 'loading',
+            'dest': 'failed'
+        },
+        {
+            'trigger': 'success',
+            'source': 'loading',
+            'dest': 'loaded'
+        },
+        {
+            'trigger': 'reload',
+            'source': 'loaded',
+            'dest': 'configuring'
+        }
+    ]
 
-    def find_by_collidepoint(self, position):
-        for key in self.keys:
-            if self.keys[key].collidepoint(position):
-                return self.keys[key]
-        return None
+    master_volume = NumericProperty(100)
+    ready_color = ListProperty([1, 165/255, 0, 1])
+    state = StringProperty("")
 
-    def find_by_unicode(self, key_sym):
+    def __init__(self, **kwargs):
+        self.keys = []
+        self.running = []
+        self.wait_ids = {}
+        self.open_files = {}
+
+        Machine(model=self, states=self.STATES,
+                transitions=self.TRANSITIONS, initial='initial',
+                ignore_invalid_triggers=True, queued=True)
+        super(Mapping, self).__init__(**kwargs)
+        self.keyboard = Window.request_keyboard(self.on_keyboard_closed, self)
+        self.keyboard.bind(on_key_down=self.on_keyboard_down)
+
+        self.configure()
+
+    def on_enter_configuring(self):
+        if Config.builtin_mixing:
+            self.mixer = Mixer()
+        else:
+            self.mixer = None
+
+        try:
+            self.key_config, self.open_files = self.parse_config()
+        except Exception as e:
+            error_print("Error while loading configuration: {}".format(e),
+                    with_trace=True)
+            sys.exit()
+        else:
+            self.success()
+
+    def on_enter_loading(self):
         for key in self.keys:
-            if self.keys[key].key_sym == key_sym:
-                return self.keys[key]
+            key.reload()
+        self.success()
+
+    # Kivy events
+    def add_widget(self, widget, index=0):
+        if type(widget).__name__ == "Key" and widget not in self.keys:
+            self.keys.append(widget)
+        return super(Mapping, self).add_widget(widget, index)
+
+    def remove_widget(self, widget, index=0):
+        if type(widget).__name__ == "Key" and widget in self.keys:
+            self.keys.remove(widget)
+        return super(Mapping, self).remove_widget(widget, index)
+
+    def on_keyboard_closed(self):
+        self.keyboard.unbind(on_key_down=self.on_keyboard_down)
+        self.keyboard = None
+
+    def on_keyboard_down(self, keyboard, keycode, text, modifiers):
+        key = self.find_by_key_code(keycode)
+        if self.allowed_modifiers(modifiers) and key is not None:
+            modifiers.sort()
+            threading.Thread(name="MSKeyAction", target=key.run,
+                    args=['-'.join(modifiers)]).start()
+        elif 'ctrl' in modifiers and (keycode[0] == 113 or keycode[0] == '99'):
+            self.stop_all_running()
+            for thread in threading.enumerate():
+                if thread.getName()[0:2] != "MS":
+                    continue
+                thread.join()
+
+            sys.exit()
+        elif 'ctrl' in modifiers and keycode[0] == 114:
+            threading.Thread(name="MSReload", target=self.reload).start()
+        return True
+
+    # Helpers
+    def allowed_modifiers(self, modifiers):
+        allowed = []
+        return len([a for a in modifiers if a not in allowed]) == 0
+
+    def find_by_key_code(self, key_code):
+        if "Key_" + str(key_code[0]) in self.ids:
+            return self.ids["Key_" + str(key_code[0])]
         return None
 
+    def all_keys_ready(self):
+        partial = False
+        for key in self.keys:
+            if not key.is_loaded_or_failed():
+                return "not_ready"
+            partial = partial or key.is_failed()
+
+        if partial:
+            return "partial"
+        else:
+            return "success"
+
+    # Callbacks
+    def key_loaded_callback(self):
+        result = self.all_keys_ready()
+        if result == "success":
+            self.ready_color = [0, 1, 0, 1]
+        elif result == "partial":
+            self.ready_color = [1, 0, 0, 1]
+        else:
+            self.ready_color = [1, 165/255, 0, 1]
+
+    ## Some global actions
     def stop_all_running(self):
+        running = self.running
         self.running = []
-
+        for (key, start_time) in running:
+            key.interrupt()
+
+    # Master volume methods
+    @property
+    def master_gain(self):
+        return gain(self.master_volume)
+
+    def set_master_volume(self, value, delta=False, fade=0):
+        [db_gain, self.master_volume] = gain(
+                value + int(delta) * self.master_volume,
+                self.master_volume)
+
+        for music in self.open_files.values():
+            music.set_gain_with_effect(db_gain, fade=fade)
+
+    # Wait handler methods
+    def add_wait_id(self, wait_id, action_or_wait):
+        self.wait_ids[wait_id] = action_or_wait
+
+    def interrupt_wait(self, wait_id):
+        if wait_id in self.wait_ids:
+            action_or_wait = self.wait_ids[wait_id]
+            del(self.wait_ids[wait_id])
+            if isinstance(action_or_wait, Action):
+                action_or_wait.interrupt()
+            else:
+                action_or_wait.set()
+
+    # Methods to control running keys
     def start_running(self, key, start_time):
         self.running.append((key, start_time))
 
@@ -169,3 +212,185 @@ class Mapping:
         if (key, start_time) in self.running:
             self.running.remove((key, start_time))
 
+    # YML config parser
+    def parse_config(self):
+        def update_alias(prop_hash, aliases, key):
+            if isinstance(aliases[key], dict):
+                prop_hash.update(aliases[key], **prop_hash)
+            else:
+                warn_print("Alias {} is not a hash, ignored".format(key))
+
+        def include_aliases(prop_hash, aliases):
+            if 'include' not in prop_hash:
+                return
+
+            included = prop_hash['include']
+            del(prop_hash['include'])
+            if isinstance(included, str):
+                update_alias(prop_hash, aliases, included)
+            elif isinstance(included, list):
+                for included_ in included:
+                    if isinstance(included_, str):
+                        update_alias(prop_hash, aliases, included_)
+                    else:
+                        warn_print("Unkown alias include type, ignored: "
+                            "{} in {}".format(included_, included))
+            else:
+                warn_print("Unkown alias include type, ignored: {}"
+                        .format(included))
+
+        def check_key_property(key_property, key):
+            if 'description' in key_property:
+                desc = key_property['description']
+                if not isinstance(desc, list):
+                    warn_print("description in key_property '{}' is not "
+                            "a list, ignored".format(key))
+                    del(key_property['description'])
+            if 'color' in key_property:
+                color = key_property['color']
+                if not isinstance(color, list)\
+                        or len(color) != 3\
+                        or not all(isinstance(item, int) for item in color)\
+                        or any(item < 0 or item > 255 for item in color):
+                    warn_print("color in key_property '{}' is not "
+                            "a list of 3 valid integers, ignored".format(key))
+                    del(key_property['color'])
+
+        def check_key_properties(config):
+            if 'key_properties' in config:
+                if isinstance(config['key_properties'], dict):
+                    return config['key_properties']
+                else:
+                    warn_print("key_properties config is not a hash, ignored")
+                    return {}
+            else:
+                return {}
+
+        def check_mapped_keys(config):
+            if 'keys' in config:
+                if isinstance(config['keys'], dict):
+                    return config['keys']
+                else:
+                    warn_print("keys config is not a hash, ignored")
+                    return {}
+            else:
+                return {}
+
+        def check_mapped_key(mapped_keys, key):
+            if not isinstance(mapped_keys[key], list):
+                warn_print("key config '{}' is not an array, ignored"
+                        .format(key))
+                return []
+            else:
+                return mapped_keys[key]
+
+        def check_music_property(music_property, filename):
+            if not isinstance(music_property, dict):
+                warn_print("music_property config '{}' is not a hash, ignored"
+                        .format(filename))
+                return {}
+            if 'name' in music_property:
+                music_property['name'] = str(music_property['name'])
+            if 'gain' in music_property:
+                try:
+                    music_property['gain'] = float(music_property['gain'])
+                except ValueError as e:
+                    del(music_property['gain'])
+                    warn_print("gain for music_property '{}' is not "
+                            "a float, ignored".format(filename))
+            return music_property
+
+        stream = open(Config.yml_file, "r")
+        try:
+            config = yaml.safe_load(stream)
+        except Exception as e:
+            error_print("Error while loading config file: {}".format(e))
+            sys.exit()
+        stream.close()
+
+        if not isinstance(config, dict):
+            raise Exception("Top level config is supposed to be a hash")
+
+        if 'aliases' in config and isinstance(config['aliases'], dict):
+            aliases = config['aliases']
+        else:
+            aliases = defaultdict(dict)
+            if 'aliases' in config:
+                warn_print("aliases config is not a hash, ignored")
+
+        music_properties = defaultdict(dict)
+        if 'music_properties' in config and\
+                isinstance(config['music_properties'], dict):
+            music_properties.update(config['music_properties'])
+        elif 'music_properties' in config:
+            warn_print("music_properties config is not a hash, ignored")
+
+        seen_files = {}
+
+        key_properties = defaultdict(lambda: {
+                "actions":    [],
+                "properties": {},
+                "files":      []
+            })
+
+        for key in check_key_properties(config):
+            key_prop = config['key_properties'][key]
+
+            if not isinstance(key_prop, dict):
+                warn_print("key_property '{}' is not a hash, ignored"
+                        .format(key))
+                continue
+
+            include_aliases(key_prop, aliases)
+            check_key_property(key_prop, key)
+
+            key_properties[key]["properties"] = key_prop
+
+        for mapped_key in check_mapped_keys(config):
+            for index, action in enumerate(check_mapped_key(
+                    config['keys'], mapped_key)):
+                if not isinstance(action, dict) or\
+                        not len(action) == 1 or\
+                        not isinstance(list(action.values())[0] or {}, dict):
+                    warn_print("action number {} of key '{}' is invalid, "
+                            "ignored".format(index + 1, mapped_key))
+                    continue
+
+                action_name = list(action)[0]
+                action_args = {}
+                if action[action_name] is None:
+                    action[action_name] = {}
+
+                include_aliases(action[action_name], aliases)
+
+                for argument in action[action_name]:
+                    if argument == 'file':
+                        filename = str(action[action_name]['file'])
+                        if filename not in seen_files:
+                            music_property = check_music_property(
+                                    music_properties[filename],
+                                    filename)
+
+                            if filename in self.open_files:
+                                self.open_files[filename]\
+                                        .reload_properties(**music_property)
+
+                                seen_files[filename] = self.open_files[filename]
+                            else:
+                                seen_files[filename] = MusicFile(
+                                        filename, self, **music_property)
+
+                        if filename not in key_properties[mapped_key]['files']:
+                            key_properties[mapped_key]['files'] \
+                                    .append(seen_files[filename])
+
+                        action_args['music'] = seen_files[filename]
+                    else:
+                        action_args[argument] = action[action_name][argument]
+
+                key_properties[mapped_key]['actions'] \
+                        .append([action_name, action_args])
+
+        return (key_properties, seen_files)
+
+