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 from .music_effect import GainEffect
  14
  15 file_lock = Lock("file")
  16
  17 class MusicFile(Machine):
  18     def __init__(self, filename, mapping, name=None, gain=1):
  19         states = [
  20             'initial',
  21             'loading',
  22             'failed',
  23             {
  24                 'name': 'loaded',
  25                 'children': ['stopped', 'playing', 'paused', 'stopping']
  26             }
  27         ]
  28         transitions = [
  29             {
  30                 'trigger': 'load',
  31                 'source': 'initial',
  32                 'dest': 'loading'
  33             },
  34             {
  35                 'trigger': 'fail',
  36                 'source': 'loading',
  37                 'dest': 'failed'
  38             },
  39             {
  40                 'trigger': 'success',
  41                 'source': 'loading',
  42                 'dest': 'loaded_stopped'
  43             },
  44             {
  45                 'trigger': 'start_playing',
  46                 'source': 'loaded_stopped',
  47                 'dest': 'loaded_playing'
  48             },
  49             {
  50                 'trigger': 'pause',
  51                 'source': 'loaded_playing',
  52                 'dest': 'loaded_paused'
  53             },
  54             {
  55                 'trigger': 'unpause',
  56                 'source': 'loaded_paused',
  57                 'dest': 'loaded_playing'
  58             },
  59             {
  60                 'trigger': 'stop_playing',
  61                 'source': ['loaded_playing','loaded_paused'],
  62                 'dest': 'loaded_stopping'
  63             },
  64             {
  65                 'trigger': 'stopped',
  66                 'source': 'loaded_stopping',
  67                 'dest': 'loaded_stopped',
  68                 'after': 'trigger_stopped_events'
  69             }
  70         ]
  71
  72         Machine.__init__(self, states=states,
  73                 transitions=transitions, initial='initial')
  74
  75         self.volume = 100
  76         self.mapping = mapping
  77         self.filename = filename
  78         self.name = name or filename
  79         self.audio_segment = None
  80         self.audio_segment_frame_width = 0
  81         self.initial_volume_factor = gain
  82         self.music_lock = Lock("music__" + filename)
  83         self.wait_event = threading.Event()
  84         self.db_gain = 0
  85         self.gain_effects = []
  86
  87         threading.Thread(name="MSMusicLoad", target=self.load).start()
  88
  89     def on_enter_loading(self):
  90         with file_lock:
  91             try:
  92                 debug_print("Loading « {} »".format(self.name))
  93                 self.mixer = self.mapping.mixer or Mixer()
  94                 initial_db_gain = gain(self.initial_volume_factor * 100)
  95                 self.audio_segment = pydub.AudioSegment \
  96                         .from_file(self.filename) \
  97                         .set_frame_rate(Config.frame_rate) \
  98                         .set_channels(Config.channels) \
  99                         .set_sample_width(Config.sample_width) \
 100                         .apply_gain(initial_db_gain)
 101                 self.audio_segment_frame_width = self.audio_segment.frame_width
 102                 self.sound_duration = self.audio_segment.duration_seconds
 103             except Exception as e:
 104                 error_print("failed to load « {} »: {}".format(self.name, e))
 105                 self.loading_error = e
 106                 self.fail()
 107             else:
 108                 self.success()
 109                 debug_print("Loaded « {} »".format(self.name))
 110
 111     def check_is_loaded(self):
 112         return self.state.startswith('loaded_')
 113
 114     def is_not_stopped(self):
 115         return self.check_is_loaded() and not self.is_loaded_stopped()
 116
 117     def is_paused(self):
 118         return self.is_loaded_paused()
 119
 120     @property
 121     def sound_position(self):
 122         if self.is_not_stopped():
 123             return self.current_frame / self.current_audio_segment.frame_rate
 124         else:
 125             return 0
 126
 127     def play(self, fade_in=0, volume=100, loop=0, start_at=0):
 128         self.set_gain(gain(volume) + self.mapping.master_gain, absolute=True)
 129         self.volume = volume
 130         self.loop = loop
 131
 132         ms = int(start_at * 1000)
 133         ms_fi = int(fade_in * 1000)
 134         with self.music_lock:
 135             self.current_audio_segment = self.audio_segment
 136             self.current_frame = int(start_at * self.audio_segment.frame_rate)
 137             if ms_fi > 0:
 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         # FIXME: self.effects_next_gain should take into account the loop number
 217         volume_factor = self.volume_factor(self.effects_next_gain(nb_frames))
 218
 219         data = audioop.mul(data, Config.sample_width, volume_factor)
 220
 221         return [data, nb_frames]
 222
 223     def seek(self, value=0, delta=False):
 224         # We don't want to do that while stopping
 225         if not (self.is_loaded_playing() or self.is_loaded_paused()):
 226             return
 227         with self.music_lock:
 228             self.abandon_all_effects()
 229             self.a_s_with_effect = None
 230             self.current_frame = max(
 231                     0,
 232                     int(delta) * self.current_frame
 233                         + int(value * self.audio_segment.frame_rate))
 234         # FIXME: si on fait un seek + delta, adapter le "loop"
 235
 236     def effects_next_gain(self, frame_count):
 237         db_gain = 0
 238         for gain_effect in self.gain_effects:
 239             [new_gain, last_gain] = gain_effect.get_next_gain(
 240                     self.current_frame,
 241                     frame_count)
 242             if last_gain:
 243                 self.set_gain(new_gain)
 244                 self.gain_effects.remove(gain_effect)
 245             else:
 246                 db_gain += new_gain
 247         return db_gain
 248
 249
 250     def abandon_all_effects(self):
 251         db_gain = 0
 252         for gain_effect in self.gain_effects:
 253             db_gain += gain_effect.get_last_gain()
 254
 255         self.gain_effects = []
 256         self.set_gain(db_gain)
 257
 258     def stop(self, fade_out=0, wait=False):
 259         if self.is_loaded_playing():
 260             ms = int(self.sound_position * 1000)
 261             ms_fo = max(1, int(fade_out * 1000))
 262
 263             new_audio_segment = self.current_audio_segment[: ms+ms_fo] \
 264                 .fade_out(ms_fo)
 265             with self.music_lock:
 266                 self.current_audio_segment = new_audio_segment
 267             self.stop_playing()
 268             if wait:
 269                 self.wait_end()
 270         else:
 271             self.stop_playing()
 272             self.stopped()
 273
 274     def volume_factor(self, additional_gain):
 275         return 10 ** ( (self.db_gain + additional_gain) / 20)
 276
 277     def set_gain(self, db_gain, absolute=False):
 278         if absolute:
 279             self.db_gain = db_gain
 280         else:
 281             self.db_gain += db_gain
 282
 283     def set_volume(self, value, delta=False, fade=0):
 284         [db_gain, self.volume] = gain(
 285                 value + int(delta) * self.volume,
 286                 self.volume)
 287
 288         if fade > 0:
 289             self.gain_effects.append(GainEffect(
 290                 "fade",
 291                 self.current_audio_segment,
 292                 self.sound_position,
 293                 self.sound_position + fade,
 294                 gain=db_gain))
 295         else:
 296             self.set_gain(db_gain)
 297
 298     def wait_end(self):
 299         self.wait_event.clear()
 300         self.wait_event.wait()
 301