]> git.immae.eu Git - perso/Immae/Projets/Python/MusicSampler.git/blame - music_sampler/key.py
Fix configuring not resetting the key
[perso/Immae/Projets/Python/MusicSampler.git] / music_sampler / key.py
CommitLineData
4b2d79ca 1from kivy.uix.widget import Widget
2e404903
IB
2from kivy.properties import AliasProperty, BooleanProperty, \
3 ListProperty, StringProperty
4b2d79ca
IB
4from kivy.uix.behaviors import ButtonBehavior
5
e55b29bb 6from .action import Action
6ebe6247 7from .helpers import debug_print
be27763f 8import time
34382290 9import threading
e55b29bb 10from transitions.extensions import HierarchicalMachine as Machine
4b2d79ca 11
ba219325 12class KeyMachine(Widget):
e55b29bb
IB
13 STATES = [
14 'initial',
15 'configuring',
16 'configured',
17 'loading',
18 'failed',
19 {
20 'name': 'loaded',
34382290
IB
21 'children': [
22 'no_config',
23 'no_actions',
24 'running',
25 'protecting_repeat'
26 ]
e55b29bb
IB
27 }
28 ]
29
30 TRANSITIONS = [
31 {
32 'trigger': 'configure',
33 'source': 'initial',
34 'dest': 'configuring'
35 },
36 {
37 'trigger': 'fail',
38 'source': 'configuring',
8ba7d831
IB
39 'dest': 'failed',
40 'after': 'key_loaded_callback'
e55b29bb
IB
41 },
42 {
43 'trigger': 'success',
44 'source': 'configuring',
45 'dest': 'configured',
46 'after': 'load'
47 },
48 {
49 'trigger': 'no_config',
50 'source': 'configuring',
51 'dest': 'loaded_no_config',
8ba7d831 52 'after': 'key_loaded_callback'
e55b29bb
IB
53 },
54 {
55 'trigger': 'load',
56 'source': 'configured',
57 'dest': 'loading'
58 },
59 {
60 'trigger': 'fail',
61 'source': 'loading',
8ba7d831
IB
62 'dest': 'failed',
63 'after': 'key_loaded_callback'
e55b29bb
IB
64 },
65 {
66 'trigger': 'success',
67 'source': 'loading',
8ba7d831
IB
68 'dest': 'loaded',
69 'after': 'key_loaded_callback'
e55b29bb
IB
70 },
71 {
72 'trigger': 'no_actions',
73 'source': 'loading',
74 'dest': 'loaded_no_actions',
8ba7d831 75 'after': 'key_loaded_callback'
e55b29bb
IB
76 },
77 {
78 'trigger': 'reload',
ab47d2a1 79 'source': ['loaded','failed'],
8ba7d831
IB
80 'dest': 'configuring',
81 'after': 'key_loaded_callback'
e55b29bb
IB
82 },
83 {
84 'trigger': 'run',
85 'source': 'loaded',
86 'dest': 'loaded_running',
b17aed6a 87 'after': ['run_actions', 'finish'],
6c42e32d
IB
88 # if a child, like loaded_no_actions, has no transitions, then it
89 # is bubbled to the parent, and we don't want that.
e55b29bb
IB
90 'conditions': ['is_loaded']
91 },
92 {
93 'trigger': 'finish',
94 'source': 'loaded_running',
34382290
IB
95 'dest': 'loaded_protecting_repeat'
96 },
97 {
98 'trigger': 'repeat_protection_finished',
99 'source': 'loaded_protecting_repeat',
e55b29bb 100 'dest': 'loaded'
34382290 101 },
e55b29bb
IB
102 ]
103
ba219325
IB
104 state = StringProperty("")
105
106 def __init__(self, key, **kwargs):
107 self.key = key
108
109 Machine(model=self, states=self.STATES,
110 transitions=self.TRANSITIONS, initial='initial',
111 ignore_invalid_triggers=True, queued=True)
112 super(KeyMachine, self).__init__(**kwargs)
113
114 # Machine states / events
115 def is_loaded_or_failed(self):
116 return self.is_loaded(allow_substates=True) or self.is_failed()
117
118 def is_loaded_inactive(self):
119 return self.is_loaded_no_config() or self.is_loaded_no_actions()
120
121 def on_enter_configuring(self):
045a1b63
IB
122 self.destroy_actions()
123 self.key.unset_description()
124 self.key.unset_color()
125
ba219325
IB
126 if self.key.key_sym in self.key.parent.key_config:
127 self.key.config = self.key.parent.key_config[self.key.key_sym]
128
ba219325
IB
129 for key_action in self.key.config['actions']:
130 self.key.add_action(key_action[0], **key_action[1])
131
132 if 'description' in self.key.config['properties']:
133 self.key.set_description(self.key.config['properties']['description'])
ba219325
IB
134 if 'color' in self.key.config['properties']:
135 self.key.set_color(self.key.config['properties']['color'])
ba219325
IB
136 self.success()
137 else:
138 self.no_config()
139
140 def on_enter_loading(self):
141 if len(self.key.actions) > 0:
142 for action in self.key.actions:
143 action.load()
144 else:
145 self.no_actions()
146
045a1b63
IB
147 def destroy_actions(self):
148 for action in self.key.actions:
149 action.destroy()
150 self.key.actions = []
151
ba219325
IB
152 def run_actions(self, modifiers):
153 self.key.parent.parent.ids['KeyList'].append(self.key.key_sym)
154 debug_print("running actions for {}".format(self.key.key_sym))
155 start_time = time.time()
06ed113d 156 self.key.parent.start_running(self.key, start_time)
ba219325 157 for self.key.current_action in self.key.actions:
06ed113d 158 if self.key.parent.keep_running(self.key, start_time):
ba219325
IB
159 self.key.list_actions()
160 self.key.current_action.run(start_time)
161 self.key.list_actions(last_action_finished=True)
162
06ed113d 163 self.key.parent.finished_running(self.key, start_time)
ba219325
IB
164
165 def on_enter_loaded_protecting_repeat(self, modifiers):
814c30c6 166 if self.key.repeat_delay > 0:
ba219325 167 self.key.protecting_repeat_timer = threading.Timer(
814c30c6 168 self.key.repeat_delay,
ba219325
IB
169 self.key.repeat_protection_finished)
170 self.key.protecting_repeat_timer.start()
171 else:
172 self.key.repeat_protection_finished()
173
174 # Callbacks
175 def key_loaded_callback(self):
176 self.key.parent.key_loaded_callback()
177
178
179class Key(ButtonBehavior, Widget):
180
4b2d79ca 181 key_sym = StringProperty(None)
e55b29bb 182 custom_color = ListProperty([0, 1, 0])
4b2d79ca
IB
183 description_title = StringProperty("")
184 description = ListProperty([])
ba219325 185 machine_state = StringProperty("")
4b2d79ca 186
635dea02 187 def get_alias_line_cross_color(self):
ea97edb3
IB
188 if not self.is_failed() and (
189 not self.is_loaded(allow_substates=True)\
190 or self.is_loaded_running()\
191 or self.is_loaded_protecting_repeat()):
635dea02
IB
192 return [120/255, 120/255, 120/255, 1]
193 else:
194 return [0, 0, 0, 0]
195
196 def set_alias_line_cross_color(self):
197 pass
198
199 line_cross_color = AliasProperty(
200 get_alias_line_cross_color,
201 set_alias_line_cross_color,
ba219325 202 bind=['machine_state'])
635dea02 203
1094ab1a
IB
204 def get_alias_line_color(self):
205 if self.is_loaded_running():
206 return [0, 0, 0, 1]
207 else:
208 return [120/255, 120/255, 120/255, 1]
209
210 def set_alias_line_color(self):
211 pass
212
213 line_color = AliasProperty(get_alias_line_color, set_alias_line_color,
ba219325 214 bind=['machine_state'])
1094ab1a 215
e55b29bb
IB
216 def get_alias_color(self):
217 if self.is_loaded_inactive():
4b2d79ca 218 return [1, 1, 1, 1]
34382290
IB
219 elif self.is_loaded_protecting_repeat():
220 return [*self.custom_color, 100/255]
70cfb266
IB
221 elif self.is_loaded_running():
222 return [*self.custom_color, 100/255]
e55b29bb
IB
223 elif self.is_loaded(allow_substates=True):
224 return [*self.custom_color, 1]
225 elif self.is_failed():
226 return [0, 0, 0, 1]
be27763f 227 else:
e55b29bb
IB
228 return [*self.custom_color, 100/255]
229 def set_alias_color(self):
4b2d79ca
IB
230 pass
231
e55b29bb 232 color = AliasProperty(get_alias_color, set_alias_color,
ba219325
IB
233 bind=['machine_state', 'custom_color'])
234
235 def __getattr__(self, name):
236 if hasattr(self.machine, name):
237 return getattr(self.machine, name)
238 else:
239 raise AttributeError
240
241 def machine_state_changed(self, instance, machine_state):
242 self.machine_state = self.machine.state
be27763f 243
4b2d79ca 244 def __init__(self, **kwargs):
be27763f 245 self.actions = []
b17aed6a 246 self.current_action = None
ba219325
IB
247 self.machine = KeyMachine(self)
248 self.machine.bind(state=self.machine_state_changed)
b17aed6a 249
e55b29bb 250 super(Key, self).__init__(**kwargs)
be27763f 251
e55b29bb 252 # Kivy events
4b2d79ca 253 def on_key_sym(self, key, key_sym):
e55b29bb
IB
254 if key_sym != "":
255 self.configure()
256
257 def on_press(self):
258 self.list_actions()
4b2d79ca 259
e55b29bb
IB
260 # This one cannot be in the Machine state since it would be queued to run
261 # *after* the loop is ended...
262 def interrupt(self):
263 self.current_action.interrupt()
264
265 # Callbacks
266 def callback_action_ready(self, action, success):
267 if not success:
268 self.fail()
269 elif all(action.is_loaded_or_failed() for action in self.actions):
270 self.success()
271
272 # Setters
b86db9f1 273 def set_description(self, description):
4b2d79ca
IB
274 if description[0] is not None:
275 self.description_title = str(description[0])
ab47d2a1 276 self.description = []
2e404903 277 for desc in description[1 :]:
d479af33
IB
278 if desc is None:
279 self.description.append("")
280 else:
4b2d79ca 281 self.description.append(str(desc).replace(" ", " "))
b86db9f1 282
b3e624bb
IB
283 def unset_description(self):
284 self.description_title = ""
285 self.description = []
286
b86db9f1 287 def set_color(self, color):
4b2d79ca 288 color = [x / 255 for x in color]
4b2d79ca 289 self.custom_color = color
be27763f 290
b3e624bb
IB
291 def unset_color(self):
292 self.custom_color = [0, 1, 0]
293
814c30c6
IB
294 # Helpers
295 @property
296 def repeat_delay(self):
7df12958
IB
297 if hasattr(self, 'config') and\
298 'repeat_delay' in self.config['properties']:
299 return self.config['properties']['repeat_delay']
814c30c6
IB
300 else:
301 return 0
302
e55b29bb 303 # Actions handling
be27763f
IB
304 def add_action(self, action_name, **arguments):
305 self.actions.append(Action(action_name, self, **arguments))
306
b17aed6a
IB
307 def list_actions(self, last_action_finished=False):
308 not_running = (not self.is_loaded_running())
309 current_action_seen = False
310 action_descriptions = []
311 for action in self.actions:
312 if not_running:
313 state = "inactive"
314 elif last_action_finished:
315 state = "done"
316 elif current_action_seen:
317 state = "pending"
318 elif action == self.current_action:
319 current_action_seen = True
320 state = "current"
321 else:
322 state = "done"
323 action_descriptions.append([action.description(), state])
324 self.parent.parent.ids['ActionList'].update_list(
325 self,
326 action_descriptions)