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