Rename helpers to music_sampler

11 files changed, 235 insertions, 0 deletions

diff --git a/music_sampler/actions/__init__.py b/music_sampler/actions/__init__.py
new file mode 100644
index 0000000..658cef0
--- /dev/null
+++ b/music_sampler/actions/__init__.py
@@ -0,0 +1,10 @@
+from . import interrupt_wait
+from . import pause
+from . import play
+from . import run_command
+from . import seek
+from . import stop
+from . import stop_all_actions
+from . import unpause
+from . import volume
+from . import wait
diff --git a/music_sampler/actions/interrupt_wait.py b/music_sampler/actions/interrupt_wait.py
new file mode 100644
index 0000000..8f465f0
--- /dev/null
+++ b/music_sampler/actions/interrupt_wait.py
@@ -0,0 +1,5 @@
+def run(action, wait_id=None, **kwargs):
+    action.mapping.interrupt_wait(wait_id)
+
+def description(action, wait_id=None, **kwargs):
+    return "interrupt wait with id {}".format(wait_id)
diff --git a/music_sampler/actions/pause.py b/music_sampler/actions/pause.py
new file mode 100644
index 0000000..bb27734
--- /dev/null
+++ b/music_sampler/actions/pause.py
@@ -0,0 +1,10 @@
+def run(action, music=None, **kwargs):
+    for music in action.music_list(music):
+        if music.is_loaded_playing():
+            music.pause()
+
+def description(action, music=None, **kwargs):
+    if music is not None:
+        return "pausing « {} »".format(music.name)
+    else:
+        return "pausing all musics"
diff --git a/music_sampler/actions/play.py b/music_sampler/actions/play.py
new file mode 100644
index 0000000..fdba95b
--- /dev/null
+++ b/music_sampler/actions/play.py
@@ -0,0 +1,44 @@
+def run(action, music=None, fade_in=0, start_at=0,
+        restart_if_running=False, volume=100,
+        loop=0, **kwargs):
+    for music in action.music_list(music):
+        if restart_if_running:
+            if music.is_in_use():
+                music.stop()
+            music.play(
+                    volume=volume,
+                    fade_in=fade_in,
+                    start_at=start_at,
+                    loop=loop)
+        elif not music.is_in_use():
+            music.play(
+                    volume=volume,
+                    fade_in=fade_in,
+                    start_at=start_at,
+                    loop=loop)
+
+def description(action, music=None, fade_in=0, start_at=0,
+        restart_if_running=False, volume=100, loop=0, **kwargs):
+    message = "starting "
+    if music is not None:
+        message += "« {} »".format(music.name)
+    else:
+        message += "all musics"
+
+    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 loop > 0:
+        message += " {} times".format(loop + 1)
+    elif loop < 0:
+        message += " in loop"
+
+    if restart_if_running:
+        message += " (restarting if already running)"
+
+    return message
diff --git a/music_sampler/actions/run_command.py b/music_sampler/actions/run_command.py
new file mode 100644
index 0000000..1e80c1e
--- /dev/null
+++ b/music_sampler/actions/run_command.py
@@ -0,0 +1,13 @@
+import shlex, subprocess
+
+def run(action, command="", wait=False, **kwargs):
+    action.process = subprocess.Popen(command, shell=True)
+    if wait:
+        action.process.wait()
+
+def description(action, command="", wait=False, **kwargs):
+    message = "running command {}".format(command)
+    if wait:
+        message += " (waiting for its execution to finish)"
+
+    return message
diff --git a/music_sampler/actions/seek.py b/music_sampler/actions/seek.py
new file mode 100644
index 0000000..467af7d
--- /dev/null
+++ b/music_sampler/actions/seek.py
@@ -0,0 +1,19 @@
+def run(action, music=None, value=0, delta=False, **kwargs):
+    for music in action.music_list(music):
+        music.seek(value=value, delta=delta)
+
+def description(action, music=None, value=0, delta=False, **kwargs):
+    if delta:
+        if music is not None:
+            return "moving music « {} » by {:+d}s" \
+                    .format(music.name, value)
+        else:
+            return "moving all musics by {:+d}s" \
+                    .format(value)
+    else:
+        if music is not None:
+            return "moving music « {} » to position {}s" \
+                    .format(music.name, value)
+        else:
+            return "moving all musics to position {}s" \
+                    .format(value)
diff --git a/music_sampler/actions/stop.py b/music_sampler/actions/stop.py
new file mode 100644
index 0000000..88cc66d
--- /dev/null
+++ b/music_sampler/actions/stop.py
@@ -0,0 +1,42 @@
+def run(action, music=None, fade_out=0, wait=False,
+        set_wait_id=None, **kwargs):
+    previous = None
+    for music in action.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
+        else:
+            music.stop(fade_out=fade_out)
+
+    if previous is not None:
+        action.waiting_music = previous
+        previous.stop(
+                fade_out=fade_out,
+                wait=wait,
+                set_wait_id=set_wait_id)
+
+def description(action, music=None, fade_out=0, wait=False,
+        set_wait_id=None, **kwargs):
+
+    message = "stopping "
+    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:
+            if set_wait_id is not None:
+                message += " (waiting the end of fadeout, with id {})"\
+                        .format(set_wait_id)
+            else:
+                message += " (waiting the end of fadeout)"
+
+    return message
+
+def interrupt(action, music=None, fade_out=0, wait=False,
+        set_wait_id=None, **kwargs):
+    if action.waiting_music is not None:
+        action.waiting_music.wait_event.set()
diff --git a/music_sampler/actions/stop_all_actions.py b/music_sampler/actions/stop_all_actions.py
new file mode 100644
index 0000000..4ea875a
--- /dev/null
+++ b/music_sampler/actions/stop_all_actions.py
@@ -0,0 +1,14 @@
+def run(action, key_start_time=0, other_only=False, **kwargs):
+    if other_only:
+        action.mapping.stop_all_running(
+                except_key=action.key,
+                key_start_time=key_start_time)
+    else:
+        action.mapping.stop_all_running()
+
+def description(action, other_only=False, **kwargs):
+    message = "stopping all actions"
+    if other_only:
+        message += " except this key"
+
+    return message
diff --git a/music_sampler/actions/unpause.py b/music_sampler/actions/unpause.py
new file mode 100644
index 0000000..5fa88c3
--- /dev/null
+++ b/music_sampler/actions/unpause.py
@@ -0,0 +1,10 @@
+def run(action, music=None, **kwargs):
+    for music in action.music_list(music):
+        if music.is_loaded_paused():
+            music.unpause()
+
+def description(action, music=None, **kwargs):
+    if music is not None:
+        return "unpausing « {} »".format(music.name)
+    else:
+        return "unpausing all musics"
diff --git a/music_sampler/actions/volume.py b/music_sampler/actions/volume.py
new file mode 100644
index 0000000..7dda3c1
--- /dev/null
+++ b/music_sampler/actions/volume.py
@@ -0,0 +1,28 @@
+def run(action, music=None, value=100, fade=0, delta=False, **kwargs):
+    if music is not None:
+        music.set_volume(value, delta=delta, fade=fade)
+    else:
+        action.mapping.set_master_volume(value, delta=delta, fade=fade)
+
+def description(action, music=None,
+        value=100, delta=False, fade=0, **kwargs):
+    message = ""
+    if delta:
+        if music is not None:
+            message += "{:+d}% to volume of « {} »" \
+                    .format(value, music.name)
+        else:
+            message += "{:+d}% to volume" \
+                    .format(value)
+    else:
+        if music is not None:
+            message += "setting volume of « {} » to {}%" \
+                    .format(music.name, value)
+        else:
+            message += "setting volume to {}%" \
+                    .format(value)
+
+    if fade > 0:
+        message += " with {}s fade".format(fade)
+
+    return message
diff --git a/music_sampler/actions/wait.py b/music_sampler/actions/wait.py
new file mode 100644
index 0000000..ea42408
--- /dev/null
+++ b/music_sampler/actions/wait.py
@@ -0,0 +1,40 @@
+import threading
+
+def run(action, duration=0, music=None, set_wait_id=None, **kwargs):
+    if set_wait_id is not None:
+        action.mapping.add_wait_id(set_wait_id, action)
+
+    action.sleep_event = threading.Event()
+    action.sleep_event_timer = threading.Timer(
+            duration,
+            action.sleep_event.set)
+
+    if music is not None:
+        music.wait_end()
+
+    action.sleep_event_timer.start()
+    action.sleep_event.wait()
+
+def description(action, duration=0, music=None, set_wait_id=None, **kwargs):
+    message = ""
+    if music is None:
+        message += "waiting {}s" \
+                .format(duration)
+    elif duration == 0:
+        message += "waiting the end of « {} »" \
+                .format(music.name)
+    else:
+        message += "waiting the end of « {} » + {}s" \
+                .format(music.name, duration)
+
+    if set_wait_id is not None:
+        message += " (setting id = {})".format(set_wait_id)
+
+    return message
+
+def interrupt(action, duration=0, music=None, **kwargs):
+    if action.sleep_event is not None:
+        action.sleep_event.set()
+        action.sleep_event_timer.cancel()
+    if music is not None:
+        music.wait_event.set()