# ../core/sound/__init__.py ''' $Rev: 623 $ $LastChangedBy: satoon101 $ $LastChangedDate: 2012-03-12 21:00:11 -0400 (Mon, 12 Mar 2012) $ ''' # ============================================================================= # >> IMPORTS # ============================================================================= # Python Imports from __future__ import with_statement from configobj import ConfigObj from path import path from random import choice from random import shuffle from mp3lib import mp3info from wave import open as wave_open # EventScripts Imports import es import gamethread # GunGame Imports from gungame51.core import get_game_dir from gungame51.core import in_map # Messaging from gungame51.core.messaging.shortcuts import langstring # ============================================================================= # >> GLOBALS # ============================================================================= # Get the es.ServerVar() instance of "gg_dynamic_chattime" gg_dynamic_chattime = es.ServerVar("gg_dynamic_chattime") # Get the es.ServerVar() instance of "mp_chattime" mp_chattime = es.ServerVar("mp_chattime") soundDir = get_game_dir('sound') iniDir = get_game_dir('cfg/gungame51/sound_packs') # winnerSounds stores a shuffled list of winner sounds to come if random winner # sounds is enabled winnerSounds = [] # defaultChatTime stores the default mp_chattime for gg_dynamic_chattime to use # if it cannot check the length of the winner sound defaultChatTime = -1 # ============================================================================= # >> CLASSES # ============================================================================= class SoundPack(object): def __init__(self, name): self.__pack__ = ConfigObj('%s/%s.ini' % (iniDir, name)) def __getitem__(self, name): if name in self.__pack__: # See if this is a random sound file if self._is_random(self.__pack__[name]): # If we are looking for a random winner sound, return the # random winner sound chosen for the current round if name == "winner": return winnerSounds[0] # Return the random sound from the file return self.get_random_sound(self.__pack__[name]) # Return the sound name return self.__pack__[name] else: return None def __getattr__(self, name): if name in self.__pack__: # See if this is a random sound file if self._is_random(self.__pack__[name]): # If we are looking for a random winner sound, return the # random winner sound chosen for the current round if name == "winner": return winnerSounds[0] # Return the random sound from the file return self.get_random_sound(self.__pack__[name]) # Return the sound name return self.__pack__[name] else: return None def get_random_sound(self, name): # Make sure the random sound file exists if not self._random_exists(name): return None # Open the random sound file with iniDir.joinpath('random_sound_files', name).open() as randomFile: # Select a random sound from the list randomSounds = [x.strip() for x in randomFile.readlines() if not x.startswith('//')] # Return the randomly selected sound if the list is not empty return choice(randomSounds) if randomSounds else None @staticmethod def _is_random(name): return name.endswith('.txt') @staticmethod def _random_exists(name): return iniDir.joinpath('random_sound_files', name).isfile() def make_downloadable(gg_loading=False): # Make the global variable winnerSounds global to this function in case we # use it below global winnerSounds # Is GunGame loading? if gg_loading: # Print message to server console es.dbgmsg(0, langstring('Load_SoundSystem')) # Make sure we are in a map if not in_map(): return # Loop through all files in the sound_pack directory for f in iniDir.walkfiles(): # Make sure the extension is ".ini" if f.ext.lower() != '.ini': continue # Grab the ConfigObj for the INI config = ConfigObj('%s/%s' % (iniDir, f.name)) # Loop through all names (keys) in the INI for name in config: # Make sure the name isn't "title" if name.lower() == 'title': continue # Make sure that the sound file exists at the given path if sound_exists(config[name]): # Make the sound downloadable es.stringtable('downloadables', 'sound/%s' % config[name]) else: # See if the file is a random sound text file if not iniDir.joinpath( 'random_sound_files', config[name]).isfile(): continue # If we are on a random winner sound, and we have more sounds # in the current list of random sounds, choose one and make it # downloadable if name == "winner" and winnerSounds: # If there are winner sounds left in the shuffled list, # remove the last used sound if len(winnerSounds) > 1: winnerSounds.pop(0) # Make the new random winner sound downloadable if sound_exists(winnerSounds[0]): es.stringtable( 'downloadables', 'sound/%s' % winnerSounds[0]) # If gg_dynamic_chattime is enabled, set the chattime if int(gg_dynamic_chattime): set_chattime() continue # If the last used winner sound is the only thing left, # clear the list so that we can fill it below winnerSounds = [] # Open the random sound file with iniDir.joinpath( 'random_sound_files', config[name]).open() as randomFile: randomSounds = randomFile.readlines() # Loop through all sounds in the file for sound in randomSounds: # Remove the line return character and whitespace, sound = sound.strip('\\n').strip() # Do not add comment lines if sound.startswith("//"): continue # If we are on a random winner sound, add it to the # random winner sounds list if name == "winner": winnerSounds.append(sound) # We will make the winner sound chosen for this round # downloadable below this loop continue # Make sure that the sound file exists at the given path if sound_exists(sound): # Make the sound downloadable es.stringtable('downloadables', 'sound/%s' % sound) # Now that we are done adding random winner sounds to # the winnerSounds list, choose one to make downloadable if name == "winner": # Shuffle the list of new winner sounds shuffle(winnerSounds) # Make the new random winner sound downloadable if sound_exists(winnerSounds[0]): es.stringtable( 'downloadables', 'sound/%s' % winnerSounds[0]) # If gg_dynamic_chattime is enabled, set the chattime if int(gg_dynamic_chattime): set_chattime() def set_chattime(): # Make the global variable defaultChatTime global to this function in case # we need to modify it global defaultChatTime # If this is the first time setting the chattime, store the default time if defaultChatTime == -1: defaultChatTime = int(mp_chattime) # If the sound does not exist on the server, use the defaultChatTime if not sound_exists(winnerSounds[0]): mp_chattime.set(defaultChatTime) return # Get the path and extension of the sound file soundPath = soundDir.joinpath(winnerSounds[0]) extension = winnerSounds[0].split(".")[-1] duration = defaultChatTime # If the sound file is an mp3, use mp3info to find its duration if extension == 'mp3': try: info = mp3info(soundPath) duration = info['MM'] * 60 + info['SS'] except: pass # If the sound file is a wav, use the wave module to find its duration elif extension == 'wav': try: w = wave_open(soundPath, 'rb') duration = float(w.getnframes()) / w.getframerate() except: pass finally: w.close() # If the duration is greater than 30 seconds, set it to 30 seconds if duration > 30: duration = 30 # Set the new mp_chattime gamethread.delayed(5, mp_chattime.set, duration) def sound_exists(sound): return soundDir.joinpath(sound).isfile()