helpers/music_file.py

   1 import threading
   2 import pydub
   3 import time
   4 from transitions.extensions import HierarchicalMachine as Machine
   5
   6 import os.path
   7
   8 from .lock import Lock
   9 from . import Config, gain, debug_print, error_print
  10 from .mixer import Mixer
  11
  12 file_lock = Lock("file")
  13
  14 class MusicFile(Machine):
  15     def __init__(self, filename, mapping, name = None, gain = 1):
  16         states = [
  17             'initial',
  18             'loading',
  19             'failed',
  20             { 'name': 'loaded', 'children': ['stopped', 'playing', 'paused', 'stopping'] }
  21         ]
  22         transitions = [
  23             { 'trigger': 'load', 'source':  'initial', 'dest': 'loading'},
  24             { 'trigger': 'fail', 'source':  'loading', 'dest': 'failed'},
  25             { 'trigger': 'success', 'source':  'loading', 'dest': 'loaded_stopped'},
  26             { 'trigger': 'start_playing', 'source':  'loaded_stopped', 'dest': 'loaded_playing'},
  27             { 'trigger': 'pause', 'source':  'loaded_playing', 'dest': 'loaded_paused'},
  28             { 'trigger': 'unpause', 'source':  'loaded_paused', 'dest': 'loaded_playing'},
  29             { 'trigger': 'stop_playing', 'source': ['loaded_playing','loaded_paused'], 'dest': 'loaded_stopping'},
  30             { 'trigger': 'stopped', 'source':  'loaded_stopping', 'dest': 'loaded_stopped', 'after': 'trigger_stopped_events'}
  31         ]
  32
  33         Machine.__init__(self, states=states, transitions=transitions, initial='initial')
  34
  35         self.volume = 100
  36         self.mapping = mapping
  37         self.filename = filename
  38         self.name = name or filename
  39         self.audio_segment = None
  40         self.audio_segment_frame_width = 0
  41         self.volume_factor = gain
  42         self.music_lock = Lock("music__" + filename)
  43         self.wait_event = threading.Event()
  44
  45         threading.Thread(name = "MSMusicLoad", target = self.load).start()
  46
  47     def on_enter_loading(self):
  48         with file_lock:
  49             try:
  50                 debug_print("Loading « {} »".format(self.name))
  51                 self.mixer = self.mapping.mixer or Mixer()
  52                 db_gain = gain(self.volume_factor * 100)
  53                 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)
  54                 self.audio_segment_frame_width = self.audio_segment.frame_width
  55                 self.sound_duration = self.audio_segment.duration_seconds
  56             except Exception as e:
  57                 error_print("failed to load « {} »: {}".format(self.name, e))
  58                 self.loading_error = e
  59                 self.fail()
  60             else:
  61                 self.success()
  62                 debug_print("Loaded « {} »".format(self.name))
  63
  64     def check_is_loaded(self):
  65         return self.state.startswith('loaded_')
  66
  67     def is_not_stopped(self):
  68         return self.check_is_loaded() and not self.is_loaded_stopped()
  69
  70     def is_paused(self):
  71         return self.is_loaded_paused()
  72
  73     @property
  74     def sound_position(self):
  75         if self.is_not_stopped():
  76             return self.current_frame / self.current_audio_segment.frame_rate
  77         else:
  78             return 0
  79
  80     def play(self, fade_in = 0, volume = 100, loop = 0, start_at = 0):
  81         db_gain = gain(volume) + self.mapping.master_gain
  82         self.volume = volume
  83         self.loop = loop
  84
  85         ms = int(start_at * 1000)
  86         ms_fi = int(fade_in * 1000)
  87         with self.music_lock:
  88             self.current_audio_segment = (self.audio_segment + db_gain)
  89             self.current_frame = int(start_at * self.audio_segment.frame_rate)
  90             if ms_fi > 0:
  91                 # FIXME: apply it to repeated when looping?
  92                 self.a_s_with_effect = self.current_audio_segment[ms:ms+ms_fi].fade_in(ms_fi)
  93                 self.current_frame_with_effect = 0
  94             else:
  95                 self.a_s_with_effect = None
  96
  97         self.start_playing()
  98
  99     def on_enter_loaded_playing(self):
 100         self.mixer.add_file(self)
 101
 102     def finished_callback(self):
 103         if self.is_loaded_playing():
 104             self.stop_playing()
 105         if self.is_loaded_stopping():
 106             self.stopped()
 107
 108     def trigger_stopped_events(self):
 109         self.mixer.remove_file(self)
 110         self.wait_event.set()
 111
 112     def play_callback(self, out_data_length, frame_count):
 113         if self.is_loaded_paused():
 114             return b'\0' * out_data_length
 115
 116         with self.music_lock:
 117             [data, nb_frames] = self.get_next_sample(frame_count)
 118             if nb_frames < frame_count:
 119                 if self.is_loaded_playing() and self.loop != 0:
 120                     self.loop -= 1
 121                     self.current_frame = 0
 122                     [new_data, new_nb_frames] = self.get_next_sample(frame_count - nb_frames)
 123                     data += new_data
 124                     nb_frames += new_nb_frames
 125                 elif nb_frames == 0:
 126                     # FIXME: too slow
 127                     threading.Thread(name = "MSFinishedCallback", target=self.finished_callback).start()
 128
 129             return data.ljust(out_data_length, b'\0')
 130
 131     def get_next_sample(self, frame_count):
 132         fw = self.audio_segment_frame_width
 133
 134         data = b""
 135         nb_frames = 0
 136         if self.a_s_with_effect is not None:
 137             segment = self.a_s_with_effect
 138             max_val = int(segment.frame_count())
 139
 140             start_i = max(self.current_frame_with_effect, 0)
 141             end_i   = min(self.current_frame_with_effect + frame_count, max_val)
 142
 143             data += segment._data[(start_i * fw):(end_i * fw)]
 144
 145             frame_count = max(0, self.current_frame_with_effect + frame_count - max_val)
 146
 147             self.current_frame_with_effect += end_i - start_i
 148             self.current_frame += end_i - start_i
 149             nb_frames += end_i - start_i
 150
 151             if frame_count > 0:
 152                 self.a_s_with_effect = None
 153
 154         segment = self.current_audio_segment
 155         max_val = int(segment.frame_count())
 156
 157         start_i = max(self.current_frame, 0)
 158         end_i   = min(self.current_frame + frame_count, max_val)
 159         data += segment._data[(start_i * fw):(end_i * fw)]
 160         nb_frames += end_i - start_i
 161         self.current_frame += end_i - start_i
 162
 163         return [data, nb_frames]
 164
 165     def seek(self, value = 0, delta = False):
 166         # We don't want to do that while stopping
 167         if not (self.is_loaded_playing() or self.is_loaded_paused()):
 168             return
 169         with self.music_lock:
 170             self.a_s_with_effect = None
 171             self.current_frame = max(0, int(delta) * self.current_frame + int(value * self.audio_segment.frame_rate))
 172         # FIXME: si on fait un seek + delta, adapter le "loop"
 173
 174     def stop(self, fade_out = 0, wait = False):
 175         if self.is_loaded_playing():
 176             ms = int(self.sound_position * 1000)
 177             ms_fo = max(1, int(fade_out * 1000))
 178
 179             new_audio_segment = self.current_audio_segment[:ms + ms_fo].fade_out(ms_fo)
 180             with self.music_lock:
 181                 self.current_audio_segment = new_audio_segment
 182             self.stop_playing()
 183             if wait:
 184                 self.wait_end()
 185         else:
 186             self.stop_playing()
 187             self.stopped()
 188
 189     def set_gain(self, db_gain):
 190         if not self.is_not_stopped():
 191             return
 192
 193         new_audio_segment = self.current_audio_segment + db_gain
 194
 195         new_a_s_with_effect = None
 196         if self.a_s_with_effect is not None:
 197             new_a_s_with_effect = self.a_s_with_effect + db_gain
 198
 199         with self.music_lock:
 200             self.current_audio_segment = new_audio_segment
 201             self.a_s_with_effect = new_a_s_with_effect
 202
 203     def set_volume(self, value, delta = False):
 204         [db_gain, self.volume] = gain(value + int(delta) * self.volume, self.volume)
 205
 206         self.set_gain(db_gain)
 207
 208     def wait_end(self):
 209         self.wait_event.clear()
 210         self.wait_event.wait()
 211