-import threading
-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'].check_is_loaded()
- else:
- return True
-
- def run(self):
- print(self.description())
- getattr(self, self.action)(**self.arguments)
-
- def description(self):
- return getattr(self, self.action + "_print")(**self.arguments)
-
- def interrupt(self):
- if getattr(self, self.action + "_interrupt", None):
- return getattr(self, self.action + "_interrupt")(**self.arguments)
-
- # Actions
- def command(self, command = "", **kwargs):
- # FIXME: todo
- pass
+ def is_loaded_or_failed(self):
+ return self.is_loaded(allow_substates=True) or self.is_failed()
- def music_list(self, music):
- if music is not None:
- return [music]
+ def callback_music_loaded(self, success):
+ if success:
+ self.success()
else:
- return self.mapping.open_files.values()
+ self.fail()
- def pause(self, music = None, **kwargs):
- for music in self.music_list(music):
- if music.is_loaded_playing():
- music.pause()
-
- def unpause(self, music = None, **kwargs):
- for music in self.music_list(music):
- if music.is_loaded_paused():
- music.unpause()
-
- 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_not_stopped():
- 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_not_stopped():
- music.play(volume = volume, fade_in = fade_in, start_at = start_at)
-
- def stop(self, music = None, fade_out = 0, wait = False, **kwargs):
- previous = None
- for music in self.music_list(music):
- if music.is_loaded_paused() or music.is_loaded_playing():
- if previous is not None:
- previous.stop(fade_out = fade_out)
- previous = music
-
- if previous is not None:
- previous.stop(fade_out = fade_out, wait = wait)
-
- def stop_all_actions(self, **kwargs):
- self.mapping.stop_all_running()
-
- def volume(self, music = None, value = 100, add = False, **kwargs):
- if music is not None:
- music.set_volume(value, add = add)
- else:
- self.mapping.set_master_volume(value, add = add)
-
- def wait(self, duration = 0, music = None, **kwargs):
- self.sleep_event = threading.Event()
-
- if music is not None:
- music.wait_end()
-
- threading.Timer(duration, self.sleep_event.set).start()
- self.sleep_event.wait()
-
- # Action messages
- 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)
+ self.success()
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)
+ error_print("Unknown action {}".format(self.action))
+ self.fail()
- message += " at volume {}%".format(volume)
+ def on_enter_loaded_running(self):
+ debug_print(self.description())
+ if hasattr(actions, self.action):
+ getattr(actions, self.action).run(self, **self.arguments)
- if restart_if_running:
- message += " (restarting if already running)"
+ def poll_loaded(self):
+ self.key.callback_action_ready(self,
+ self.is_loaded(allow_substates=True))
- return message
+ # 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)
- def stop_print(self, music = None, fade_out = 0, wait = False, **kwargs):
- message = "stopping "
+ # Helpers
+ def music_list(self, music):
if music is not None:
- message += "music « {} »".format(music.name)
- else:
- message += "all musics"
-
- if fade_out > 0:
- message += " with {}s fadeout".format(fade_out)
- if wait:
- message += " (waiting the end of fadeout)"
-
- return message
-
- def stop_all_actions_print(self, **kwargs):
- return "stopping all actions"
-
- def volume_print(self, music = None, value = 100, add = False, **kwargs):
- if add:
- if music is not None:
- return "{:+d}% to volume of « {} »".format(value, music.name)
- else:
- return "{:+d}% to volume".format(value)
+ return [music]
else:
- if music is not None:
- return "setting volume of « {} » to {}%".format(music.name, value)
- else:
- return "setting volume to {}%".format(value)
+ return self.mapping.open_files.values()
- def wait_print(self, duration = 0, music = None, **kwargs):
- if music is None:
- return "waiting {}s".format(duration)
- elif duration == 0:
- return "waiting the end of « {} »".format(music.name)
+ def description(self):
+ if hasattr(actions, self.action):
+ return getattr(actions, self.action)\
+ .description(self, **self.arguments)
else:
- return "waiting the end of « {} » + {}s".format(music.name, duration)
-
-
- # Interruptions
- def wait_interrupt(self, duration = 0, music = None, **kwargs):
- if self.sleep_event is not None:
- self.sleep_event.set()
- if music is not None:
- music.wait_event.set()
-
+ return "unknown action {}".format(self.action)