]> git.immae.eu Git - perso/Immae/Projets/Python/MusicSampler.git/blobdiff - helpers/action.py
Move actions to separate files
[perso/Immae/Projets/Python/MusicSampler.git] / helpers / action.py
index 42a08d0b875136ab4459abf4ea9ea239a496227d..1f374ec6a4ffb843e8e938b27fb85b61a0a611f4 100644 (file)
-import pygame
-import time
+from transitions.extensions import HierarchicalMachine as Machine
+from . import debug_print, error_print
+from . import actions
 
 class Action:
-    action_types = [
-        'command',
-        'pause',
-        'play',
-        'stop',
-        'stop_all_actions',
-        'unpause',
-        'volume',
-        'wait',
+    STATES = [
+        'initial',
+        'loading',
+        'failed',
+        {
+            'name': 'loaded',
+            'children': ['running']
+        }
+    ]
+
+    TRANSITIONS = [
+        {
+            'trigger': 'load',
+            'source': 'initial',
+            'dest': 'loading'
+        },
+        {
+            'trigger': 'fail',
+            'source': 'loading',
+            'dest': 'failed',
+            'after': 'poll_loaded'
+        },
+        {
+            'trigger': 'success',
+            'source': 'loading',
+            'dest': 'loaded',
+            'after': 'poll_loaded'
+        },
+        {
+            'trigger': 'run',
+            'source': 'loaded',
+            'dest': 'loaded_running',
+            'after': 'finish_action',
+            # if a child has no transitions, then it is bubbled to the parent,
+            # and we don't want that. Not useful in that machine precisely.
+            'conditions': ['is_loaded']
+        },
+        {
+            'trigger': 'finish_action',
+            'source': 'loaded_running',
+            'dest': 'loaded'
+        }
     ]
 
     def __init__(self, action, key, **kwargs):
-        if action in self.action_types:
-            self.action = action
-        else:
-            raise Exception("Unknown action {}".format(action))
+        Machine(model=self, states=self.STATES,
+                transitions=self.TRANSITIONS, initial='initial',
+                ignore_invalid_triggers=True, queued=True)
 
+        self.action = action
         self.key = key
+        self.mapping = key.parent
         self.arguments = kwargs
+        self.sleep_event = None
+        self.waiting_music = None
 
-    def ready(self):
-        if 'music' in self.arguments:
-            return self.arguments['music'].loaded
-        else:
-            return True
-
-    def run(self):
-        print(self.description())
-        getattr(self, self.action)(**self.arguments)
-        pygame.event.post(pygame.event.Event(pygame.USEREVENT))
-
-    def description(self):
-        return getattr(self, self.action + "_print")(**self.arguments)
-
-    def command(self, command = "", **kwargs):
-        pass
-
-    def pause(self, music = None, **kwargs):
-        if music is not None:
-            music.pause()
-        else:
-            pygame.mixer.pause()
+    def is_loaded_or_failed(self):
+        return self.is_loaded(allow_substates=True) or self.is_failed()
 
-    def unpause(self, music = None, **kwargs):
-        if music is not None:
-            music.unpause()
+    def callback_music_loaded(self, success):
+        if success:
+            self.success()
         else:
-            pygame.mixer.unpause()
+            self.fail()
 
-    def play(self, music = None, fade_in = 0, start_at = 0,
-            restart_if_running = False, volume = 100, **kwargs):
-        if music is not None:
-            if restart_if_running:
-                if music.is_playing():
-                    music.stop()
-                music.play(volume = volume, fade_in = fade_in, start_at = start_at)
+    # Machine states / events
+    def on_enter_loading(self):
+        if hasattr(actions, self.action):
+            if 'music' in self.arguments:
+                self.arguments['music'].subscribe_loaded(self.callback_music_loaded)
             else:
-                if not music.is_playing():
-                    music.play(volume = volume, fade_in = fade_in, start_at = start_at)
-        else:
-            pygame.mixer.unpause()
-
-    def stop(self, music = None, fade_out = 0, **kwargs):
-        if music is not None:
-            music.stop(fade_out = fade_out)
+                self.success()
         else:
-            if fade_out > 0:
-                pygame.fadeout(int(fade_out * 1000))
-            else:
-                pygame.mixer.stop()
-
-    def stop_all_actions(self, **kwargs):
-        self.key.mapping.stop_all_running()
-
-    def volume(self, music = None, value = 100, **kwargs):
+            error_print("Unknown action {}".format(self.action))
+            self.fail()
+
+    def on_enter_loaded_running(self):
+        debug_print(self.description())
+        if hasattr(actions, self.action):
+            getattr(actions, self.action).run(self, **self.arguments)
+
+    def poll_loaded(self):
+        self.key.callback_action_ready(self,
+                self.is_loaded(allow_substates=True))
+
+    # This one cannot be in the Machine state since it would be queued to run
+    # *after* the wait is ended...
+    def interrupt(self):
+        if getattr(actions, self.action, None) and\
+                hasattr(getattr(actions, self.action), 'interrupt'):
+            return getattr(getattr(actions, self.action), 'interrupt')(
+                    self, **self.arguments)
+
+    # Helpers
+    def music_list(self, music):
         if music is not None:
-            music.set_volume(value)
-        else:
-            pass
-
-    def wait(self, duration = 0, music = None, **kwargs):
-        # FIXME: Make it stoppable
-        # http://stackoverflow.com/questions/29082268/python-time-sleep-vs-event-wait
-        if music is None:
-            time.sleep(duration)
+            return [music]
         else:
-            # TODO
-            music.wait_end()
+            return self.mapping.open_files.values()
 
-    def command_print(self, command = "", **kwargs):
-        return "running command {}".format(command)
-
-    def pause_print(self, music = None, **kwargs):
-        if music is not None:
-            return "pausing « {} »".format(music.name)
-        else:
-            return "pausing all musics"
-
-    def unpause_print(self, music = None, **kwargs):
-        if music is not None:
-            return "unpausing « {} »".format(music.name)
-        else:
-            return "unpausing all musics"
-
-    def play_print(self, music = None, fade_in = 0, start_at = 0,
-            restart_if_running = False, volume = 100, **kwargs):
-        message = "starting "
-        if music is not None:
-            message += "« {} »".format(music.name)
-        else:
-            message += "music"
-
-        if start_at != 0:
-            message += " at {}s".format(start_at)
-
-        if fade_in != 0:
-            message += " with {}s fade_in".format(fade_in)
-
-        message += " at volume {}%".format(volume)
-
-        if restart_if_running:
-            message += " (restarting if already running)"
-
-        return message
-
-    def stop_print(self, music = None, fade_out = 0, **kwargs):
-        if music is not None:
-            if fade_out == 0:
-                return "stopping music « {} »".format(music.name)
-            else:
-                return "stopping music « {} » with {}s fadeout".format(music.name, fade_out)
-        else:
-            if fade_out == 0:
-                return "stopping all musics"
-            else:
-                return "stopping all musics with {}s fadeout".format(fade_out)
-
-    def stop_all_actions_print(self, **kwargs):
-        return "stopping all actions"
-
-    def volume_print(self, music = None, value = 100, **kwargs):
-        if music is not None:
-            return "setting volume of « {} » to {}%".format(music.name, value)
+    def description(self):
+        if hasattr(actions, self.action):
+            return getattr(actions, self.action)\
+                    .description(self, **self.arguments)
         else:
-            return "setting volume to {}%".format(value)
-
-    def wait_print(self, duration, **kwargs):
-        return "waiting {}s".format(duration)
-
-
+            return "unknown action {}".format(self.action)