helpers/music_file.py

   1 import threading
   2 import pydub
   3 import time
   4 from transitions.extensions import HierarchicalMachine as Machine
   5
   6 import sounddevice as sd
   7 import os.path
   8
   9 from .lock import Lock
  10 from . import gain
  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'}
  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.stream = None
  39         self.name = name or filename
  40         self.audio_segment = None
  41         self.audio_segment_frame_width = 0
  42         self.volume_factor = gain
  43         self.music_lock = Lock("music__" + filename)
  44         self.wait_event = threading.Event()
  45
  46         threading.Thread(name = "MSMusicLoad", target = self.load).start()
  47
  48     def on_enter_loading(self):
  49         with file_lock:
  50             try:
  51                 print("Loading « {} »".format(self.name))
  52                 db_gain = gain(self.volume_factor * 100)
  53                 self.audio_segment = pydub.AudioSegment.from_file(self.filename).set_frame_rate(44100).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                 print("failed to load « {} »: {}".format(self.name, e))
  58                 self.loading_error = e
  59                 self.fail()
  60             else:
  61                 self.success()
  62                 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.before_loaded_playing()
  98         self.start_playing()
  99
 100     def before_loaded_playing(self):
 101         with self.music_lock:
 102             segment = self.current_audio_segment
 103
 104             self.stream = sd.RawOutputStream(samplerate=segment.frame_rate,
 105                             channels=segment.channels,
 106                             dtype='int' + str(8*segment.sample_width), # FIXME: ?
 107                             latency=1.,
 108                             callback=self.play_callback,
 109                             finished_callback=self.finished_callback
 110                             )
 111
 112     def on_enter_loaded_playing(self):
 113         self.stream.start()
 114
 115     def on_enter_loaded_paused(self):
 116         self.stream.stop()
 117
 118     def finished_callback(self):
 119         if self.is_loaded_playing():
 120             self.stop_playing()
 121         if self.is_loaded_stopping():
 122             self.stopped()
 123
 124     def on_enter_loaded_stopped(self):
 125         self.wait_event.set()
 126
 127     def play_callback(self, out_data, frame_count, time_info, status_flags):
 128         with self.music_lock:
 129             [data, nb_frames] = self.get_next_sample(frame_count)
 130             if nb_frames < frame_count:
 131                 if self.is_loaded_playing() and self.loop != 0:
 132                     self.loop -= 1
 133                     self.current_frame = 0
 134                     [new_data, new_nb_frames] = self.get_next_sample(frame_count - nb_frames)
 135                     data += new_data
 136                     nb_frames += new_nb_frames
 137                 elif nb_frames == 0:
 138                     raise sd.CallbackStop
 139
 140             out_data[:] = data.ljust(len(out_data), b'\0')
 141
 142     def get_next_sample(self, frame_count):
 143         fw = self.audio_segment_frame_width
 144
 145         data = b""
 146         nb_frames = 0
 147         if self.a_s_with_effect is not None:
 148             segment = self.a_s_with_effect
 149             max_val = int(segment.frame_count())
 150
 151             start_i = max(self.current_frame_with_effect, 0)
 152             end_i   = min(self.current_frame_with_effect + frame_count, max_val)
 153
 154             data += segment._data[(start_i * fw):(end_i * fw)]
 155
 156             frame_count = max(0, self.current_frame_with_effect + frame_count - max_val)
 157
 158             self.current_frame_with_effect += end_i - start_i
 159             self.current_frame += end_i - start_i
 160             nb_frames += end_i - start_i
 161
 162             if frame_count > 0:
 163                 self.a_s_with_effect = None
 164
 165         segment = self.current_audio_segment
 166         max_val = int(segment.frame_count())
 167
 168         start_i = max(self.current_frame, 0)
 169         end_i   = min(self.current_frame + frame_count, max_val)
 170         data += segment._data[(start_i * fw):(end_i * fw)]
 171         nb_frames += end_i - start_i
 172         self.current_frame += end_i - start_i
 173
 174         return [data, nb_frames]
 175
 176     def seek(self, value = 0, delta = False):
 177         # We don't want to do that while stopping
 178         if not (self.is_loaded_playing() or self.is_loaded_paused()):
 179             return
 180         with self.music_lock:
 181             self.a_s_with_effect = None
 182             self.current_frame = max(0, int(delta) * self.current_frame + int(value * self.audio_segment.frame_rate))
 183         # FIXME: si on fait un seek + delta, adapter le "loop"
 184
 185     def stop(self, fade_out = 0, wait = False):
 186         if self.is_loaded_playing():
 187             ms = int(self.sound_position * 1000)
 188             ms_fo = max(1, int(fade_out * 1000))
 189
 190             # FIXME: stop fade_out puis seek -5 -> on abandonne le fade ? (cf
 191             # commentaire dans fonction seek
 192             with self.music_lock:
 193                 self.current_audio_segment = self.current_audio_segment[:ms + ms_fo].fade_out(ms_fo)
 194                 self.stop_playing()
 195             if wait:
 196                 self.wait_end()
 197         else:
 198             self.stop_playing()
 199             self.stopped()
 200
 201     def set_gain(self, db_gain):
 202         if not self.is_not_stopped():
 203             return
 204
 205         new_audio_segment = self.current_audio_segment + db_gain
 206
 207         new_a_s_with_effect = None
 208         if self.a_s_with_effect is not None:
 209             new_a_s_with_effect = self.a_s_with_effect + db_gain
 210
 211         with self.music_lock:
 212             self.current_audio_segment = new_audio_segment
 213             self.a_s_with_effect = new_a_s_with_effect
 214
 215     def set_volume(self, value, delta = False):
 216         [db_gain, self.volume] = gain(value + int(delta) * self.volume, self.volume)
 217
 218         self.set_gain(db_gain)
 219
 220     def wait_end(self):
 221         self.wait_event.clear()
 222         self.wait_event.wait()
 223
 224 # Add some more functions to AudioSegments
 225 def get_sample_slice_data(self, start_sample=0, end_sample=float('inf')):
 226     max_val = int(self.frame_count())
 227
 228     start_i = max(start_sample, 0) * self.frame_width
 229     end_i =   min(end_sample, max_val) * self.frame_width
 230
 231     return self._data[start_i:end_i]
 232
 233 pydub.AudioSegment.get_sample_slice_data = get_sample_slice_data