helpers/action.py

   1 import threading
   2 import time
   3
   4 class Action:
   5     action_types = [
   6         'command',
   7         'pause',
   8         'play',
   9         'seek',
  10         'stop',
  11         'stop_all_actions',
  12         'unpause',
  13         'volume',
  14         'wait',
  15     ]
  16
  17     def __init__(self, action, key, **kwargs):
  18         if action in self.action_types:
  19             self.action = action
  20         else:
  21             raise Exception("Unknown action {}".format(action))
  22
  23         self.key = key
  24         self.mapping = key.parent
  25         self.arguments = kwargs
  26         self.sleep_event = None
  27
  28     def ready(self):
  29         if 'music' in self.arguments:
  30             return self.arguments['music'].check_is_loaded()
  31         else:
  32             return True
  33
  34     def run(self):
  35         print(self.description())
  36         getattr(self, self.action)(**self.arguments)
  37
  38     def description(self):
  39         return getattr(self, self.action + "_print")(**self.arguments)
  40
  41     def interrupt(self):
  42         if getattr(self, self.action + "_interrupt", None):
  43             return getattr(self, self.action + "_interrupt")(**self.arguments)
  44
  45     def music_list(self, music):
  46         if music is not None:
  47             return [music]
  48         else:
  49             return self.mapping.open_files.values()
  50
  51     # Actions
  52     def command(self, command = "", **kwargs):
  53         # FIXME: todo
  54         pass
  55
  56     def pause(self, music = None, **kwargs):
  57         for music in self.music_list(music):
  58             if music.is_loaded_playing():
  59                 music.pause()
  60
  61     def unpause(self, music = None, **kwargs):
  62         for music in self.music_list(music):
  63             if music.is_loaded_paused():
  64                 music.unpause()
  65
  66     def play(self, music = None, fade_in = 0, start_at = 0,
  67             restart_if_running = False, volume = 100,
  68             loop = 0,
  69             **kwargs):
  70         for music in self.music_list(music):
  71             if restart_if_running:
  72                 if music.is_not_stopped():
  73                     music.stop()
  74                 music.play(volume = volume, fade_in = fade_in, start_at = start_at, loop = loop)
  75             else:
  76                 if not music.is_not_stopped():
  77                     music.play(volume = volume, fade_in = fade_in, start_at = start_at, loop = loop)
  78
  79     def seek(self, music = None, value = 0, delta = False, **kwargs):
  80         for music in self.music_list(music):
  81             music.seek(value = value, delta = delta)
  82
  83     def stop(self, music = None, fade_out = 0, wait = False, **kwargs):
  84         previous = None
  85         for music in self.music_list(music):
  86             if music.is_loaded_paused() or music.is_loaded_playing():
  87                 if previous is not None:
  88                     previous.stop(fade_out = fade_out)
  89                 previous = music
  90
  91         if previous is not None:
  92             previous.stop(fade_out = fade_out, wait = wait)
  93
  94     def stop_all_actions(self, **kwargs):
  95         self.mapping.stop_all_running()
  96
  97     def volume(self, music = None, value = 100, delta = False, **kwargs):
  98         if music is not None:
  99             music.set_volume(value, delta = delta)
 100         else:
 101             self.mapping.set_master_volume(value, delta = delta)
 102
 103     def wait(self, duration = 0, music = None, **kwargs):
 104         self.sleep_event = threading.Event()
 105
 106         if music is not None:
 107             music.wait_end()
 108
 109         threading.Timer(duration, self.sleep_event.set).start()
 110         self.sleep_event.wait()
 111
 112     # Action messages
 113     def command_print(self, command = "", **kwargs):
 114         return "running command {}".format(command)
 115
 116     def pause_print(self, music = None, **kwargs):
 117         if music is not None:
 118             return "pausing « {} »".format(music.name)
 119         else:
 120             return "pausing all musics"
 121
 122     def unpause_print(self, music = None, **kwargs):
 123         if music is not None:
 124             return "unpausing « {} »".format(music.name)
 125         else:
 126             return "unpausing all musics"
 127
 128     def play_print(self, music = None, fade_in = 0, start_at = 0,
 129             restart_if_running = False, volume = 100, loop = 0, **kwargs):
 130         message = "starting "
 131         if music is not None:
 132             message += "« {} »".format(music.name)
 133         else:
 134             message += "all musics"
 135
 136         if start_at != 0:
 137             message += " at {}s".format(start_at)
 138
 139         if fade_in != 0:
 140             message += " with {}s fade_in".format(fade_in)
 141
 142         message += " at volume {}%".format(volume)
 143
 144         if loop > 0:
 145             message += " {} times".format(loop + 1)
 146         elif loop < 0:
 147             message += " in loop"
 148
 149         if restart_if_running:
 150             message += " (restarting if already running)"
 151
 152         return message
 153
 154     def stop_print(self, music = None, fade_out = 0, wait = False, **kwargs):
 155         message = "stopping "
 156         if music is not None:
 157             message += "music « {} »".format(music.name)
 158         else:
 159             message += "all musics"
 160
 161         if fade_out > 0:
 162             message += " with {}s fadeout".format(fade_out)
 163             if wait:
 164                 message += " (waiting the end of fadeout)"
 165
 166         return message
 167
 168     def stop_all_actions_print(self, **kwargs):
 169         return "stopping all actions"
 170
 171     def seek_print(self, music = None, value = 0, delta = False, **kwargs):
 172         if delta:
 173             if music is not None:
 174                 return "moving music « {} » by {:+d}s".format(music.name, value)
 175             else:
 176                 return "moving all musics by {:+d}s".format(value)
 177         else:
 178             if music is not None:
 179                 return "moving music « {} » to position {}s".format(music.name, value)
 180             else:
 181                 return "moving all musics to position {}s".format(value)
 182
 183     def volume_print(self, music = None, value = 100, delta = False, **kwargs):
 184         if delta:
 185             if music is not None:
 186                 return "{:+d}% to volume of « {} »".format(value, music.name)
 187             else:
 188                 return "{:+d}% to volume".format(value)
 189         else:
 190             if music is not None:
 191                 return "setting volume of « {} » to {}%".format(music.name, value)
 192             else:
 193                 return "setting volume to {}%".format(value)
 194
 195     def wait_print(self, duration = 0, music = None, **kwargs):
 196         if music is None:
 197             return "waiting {}s".format(duration)
 198         elif duration == 0:
 199             return "waiting the end of « {} »".format(music.name)
 200         else:
 201             return "waiting the end of « {} » + {}s".format(music.name, duration)
 202
 203
 204     # Interruptions
 205     def wait_interrupt(self, duration = 0, music = None, **kwargs):
 206         if self.sleep_event is not None:
 207             self.sleep_event.set()
 208         if music is not None:
 209             music.wait_event.set()
 210