path: root/helpers/music_file.py

import threading
import pydub
import time
from transitions.extensions import HierarchicalMachine as Machine

import os.path

from .lock import Lock
from . import Config, gain
from .mixer import Mixer

file_lock = Lock("file")

class MusicFile(Machine):
    def __init__(self, filename, mapping, name = None, gain = 1):
        states = [
            'initial',
            'loading',
            'failed',
            { 'name': 'loaded', 'children': ['stopped', 'playing', 'paused', 'stopping'] }
        ]
        transitions = [
            { 'trigger': 'load', 'source':  'initial', 'dest': 'loading'},
            { 'trigger': 'fail', 'source':  'loading', 'dest': 'failed'},
            { 'trigger': 'success', 'source':  'loading', 'dest': 'loaded_stopped'},
            { 'trigger': 'start_playing', 'source':  'loaded_stopped', 'dest': 'loaded_playing'},
            { 'trigger': 'pause', 'source':  'loaded_playing', 'dest': 'loaded_paused'},
            { 'trigger': 'unpause', 'source':  'loaded_paused', 'dest': 'loaded_playing'},
            { 'trigger': 'stop_playing', 'source': ['loaded_playing','loaded_paused'], 'dest': 'loaded_stopping'},
            { 'trigger': 'stopped', 'source':  'loaded_stopping', 'dest': 'loaded_stopped', 'after': 'trigger_stopped_events'}
        ]

        Machine.__init__(self, states=states, transitions=transitions, initial='initial')

        # FIXME: catch error here
        self.mixer = mapping.mixer or Mixer()
        self.volume = 100
        self.mapping = mapping
        self.filename = filename
        self.name = name or filename
        self.audio_segment = None
        self.audio_segment_frame_width = 0
        self.volume_factor = gain
        self.music_lock = Lock("music__" + filename)
        self.wait_event = threading.Event()

        threading.Thread(name = "MSMusicLoad", target = self.load).start()

    def on_enter_loading(self):
        with file_lock:
            try:
                print("Loading « {} »".format(self.name))
                db_gain = gain(self.volume_factor * 100)
                self.audio_segment = pydub.AudioSegment.from_file(self.filename).set_frame_rate(Config.frame_rate).set_channels(Config.channels).set_sample_width(Config.sample_width).apply_gain(db_gain)
                self.audio_segment_frame_width = self.audio_segment.frame_width
                self.sound_duration = self.audio_segment.duration_seconds
            except Exception as e:
                print("failed to load « {} »: {}".format(self.name, e))
                self.loading_error = e
                self.fail()
            else:
                self.success()
                print("Loaded « {} »".format(self.name))

    def check_is_loaded(self):
        return self.state.startswith('loaded_')

    def is_not_stopped(self):
        return self.check_is_loaded() and not self.is_loaded_stopped()

    def is_paused(self):
        return self.is_loaded_paused()

    @property
    def sound_position(self):
        if self.is_not_stopped():
            return self.current_frame / self.current_audio_segment.frame_rate
        else:
            return 0

    def play(self, fade_in = 0, volume = 100, loop = 0, start_at = 0):
        db_gain = gain(volume) + self.mapping.master_gain
        self.volume = volume
        self.loop = loop

        ms = int(start_at * 1000)
        ms_fi = int(fade_in * 1000)
        with self.music_lock:
            self.current_audio_segment = (self.audio_segment + db_gain)
            self.current_frame = int(start_at * self.audio_segment.frame_rate)
            if ms_fi > 0:
                # FIXME: apply it to repeated when looping?
                self.a_s_with_effect = self.current_audio_segment[ms:ms+ms_fi].fade_in(ms_fi)
                self.current_frame_with_effect = 0
            else:
                self.a_s_with_effect = None

        self.start_playing()

    def on_enter_loaded_playing(self):
        self.mixer.add_file(self)

    def finished_callback(self):
        if self.is_loaded_playing():
            self.stop_playing()
        if self.is_loaded_stopping():
            self.stopped()

    def trigger_stopped_events(self):
        self.mixer.remove_file(self)
        self.wait_event.set()

    def play_callback(self, out_data_length, frame_count):
        if self.is_loaded_paused():
            return b'\0' * out_data_length

        with self.music_lock:
            [data, nb_frames] = self.get_next_sample(frame_count)
            if nb_frames < frame_count:
                if self.is_loaded_playing() and self.loop != 0:
                    self.loop -= 1
                    self.current_frame = 0
                    [new_data, new_nb_frames] = self.get_next_sample(frame_count - nb_frames)
                    data += new_data
                    nb_frames += new_nb_frames
                elif nb_frames == 0:
                    # FIXME: too slow
                    threading.Thread(name = "MSFinishedCallback", target=self.finished_callback).start()

            return data.ljust(out_data_length, b'\0')

    def get_next_sample(self, frame_count):
        fw = self.audio_segment_frame_width

        data = b""
        nb_frames = 0
        if self.a_s_with_effect is not None:
            segment = self.a_s_with_effect
            max_val = int(segment.frame_count())

            start_i = max(self.current_frame_with_effect, 0)
            end_i   = min(self.current_frame_with_effect + frame_count, max_val)

            data += segment._data[(start_i * fw):(end_i * fw)]

            frame_count = max(0, self.current_frame_with_effect + frame_count - max_val)

            self.current_frame_with_effect += end_i - start_i
            self.current_frame += end_i - start_i
            nb_frames += end_i - start_i

            if frame_count > 0:
                self.a_s_with_effect = None

        segment = self.current_audio_segment
        max_val = int(segment.frame_count())

        start_i = max(self.current_frame, 0)
        end_i   = min(self.current_frame + frame_count, max_val)
        data += segment._data[(start_i * fw):(end_i * fw)]
        nb_frames += end_i - start_i
        self.current_frame += end_i - start_i

        return [data, nb_frames]

    def seek(self, value = 0, delta = False):
        # We don't want to do that while stopping
        if not (self.is_loaded_playing() or self.is_loaded_paused()):
            return
        with self.music_lock:
            self.a_s_with_effect = None
            self.current_frame = max(0, int(delta) * self.current_frame + int(value * self.audio_segment.frame_rate))
        # FIXME: si on fait un seek + delta, adapter le "loop"

    def stop(self, fade_out = 0, wait = False):
        if self.is_loaded_playing():
            ms = int(self.sound_position * 1000)
            ms_fo = max(1, int(fade_out * 1000))

            # FIXME: stop fade_out puis seek -5 -> on abandonne le fade ? (cf
            # commentaire dans fonction seek
            new_audio_segment = self.current_audio_segment[:ms + ms_fo].fade_out(ms_fo)
            with self.music_lock:
                self.current_audio_segment = new_audio_segment
            self.stop_playing()
            if wait:
                self.wait_end()
        else:
            self.stop_playing()
            self.stopped()

    def set_gain(self, db_gain):
        if not self.is_not_stopped():
            return

        new_audio_segment = self.current_audio_segment + db_gain

        new_a_s_with_effect = None
        if self.a_s_with_effect is not None:
            new_a_s_with_effect = self.a_s_with_effect + db_gain

        with self.music_lock:
            self.current_audio_segment = new_audio_segment
            self.a_s_with_effect = new_a_s_with_effect

    def set_volume(self, value, delta = False):
        [db_gain, self.volume] = gain(value + int(delta) * self.volume, self.volume)

        self.set_gain(db_gain)

    def wait_end(self):
        self.wait_event.clear()
        self.wait_event.wait()