#region Copyright & License Information /* * Copyright 2007-2015 The OpenRA Developers (see AUTHORS) * This file is part of OpenRA, which is free software. It is made * available to you under the terms of the GNU General Public License * as published by the Free Software Foundation. For more information, * see COPYING. */ #endregion using System; using System.Linq; using System.Reflection; using OpenRA.FileFormats; using OpenRA.GameRules; using OpenRA.Primitives; namespace OpenRA { public sealed class Sound : IDisposable { readonly ISoundEngine soundEngine; Cache sounds; ISoundSource rawSource; ISound music; ISound video; MusicInfo currentMusic; public Sound(string engineName) { var enginePath = Platform.ResolvePath(".", "OpenRA.Platforms." + engineName + ".dll"); soundEngine = CreateDevice(Assembly.LoadFile(enginePath)); } static ISoundEngine CreateDevice(Assembly platformDll) { foreach (PlatformAttribute r in platformDll.GetCustomAttributes(typeof(PlatformAttribute), false)) { var factory = (IDeviceFactory)r.Type.GetConstructor(Type.EmptyTypes).Invoke(null); return factory.CreateSound(); } throw new InvalidOperationException("Platform DLL is missing PlatformAttribute to tell us what type to use!"); } ISoundSource LoadSound(string filename) { if (!Game.ModData.ModFiles.Exists(filename)) { Log.Write("sound", "LoadSound, file does not exist: {0}", filename); return null; } if (filename.ToLowerInvariant().EndsWith("wav")) using (var s = Game.ModData.ModFiles.Open(filename)) return LoadWave(new WavLoader(s)); using (var s = Game.ModData.ModFiles.Open(filename)) return LoadSoundRaw(AudLoader.LoadSound(s), 1, 16, 22050); } ISoundSource LoadWave(WavLoader wave) { return soundEngine.AddSoundSourceFromMemory(wave.RawOutput, wave.Channels, wave.BitsPerSample, wave.SampleRate); } ISoundSource LoadSoundRaw(byte[] rawData, int channels, int sampleBits, int sampleRate) { return soundEngine.AddSoundSourceFromMemory(rawData, channels, sampleBits, sampleRate); } public void Initialize() { sounds = new Cache(LoadSound); music = null; currentMusic = null; video = null; } public SoundDevice[] AvailableDevices() { var defaultDevices = new[] { new SoundDevice("Default", null, "Default Output"), new SoundDevice("Null", null, "Output Disabled") }; return defaultDevices.Concat(soundEngine.AvailableDevices()).ToArray(); } public void SetListenerPosition(WPos position) { soundEngine.SetListenerPosition(position); } ISound Play(Player player, string name, bool headRelative, WPos pos, float volumeModifier = 1f, bool loop = false) { if (string.IsNullOrEmpty(name)) return null; if (player != null && player != player.World.LocalPlayer) return null; return soundEngine.Play2D(sounds[name], loop, headRelative, pos, InternalSoundVolume * volumeModifier, true); } public void StopAudio() { soundEngine.StopAllSounds(); } public ISound Play(string name) { return Play(null, name, true, WPos.Zero, 1f); } public ISound Play(string name, WPos pos) { return Play(null, name, false, pos, 1f); } public ISound Play(string name, float volumeModifier) { return Play(null, name, true, WPos.Zero, volumeModifier); } public ISound Play(string name, WPos pos, float volumeModifier) { return Play(null, name, false, pos, volumeModifier); } public ISound PlayToPlayer(Player player, string name) { return Play(player, name, true, WPos.Zero, 1f); } public ISound PlayToPlayer(Player player, string name, WPos pos) { return Play(player, name, false, pos, 1f); } public ISound PlayLooped(string name) { return PlayLooped(name, WPos.Zero); } public ISound PlayLooped(string name, WPos pos) { return Play(null, name, true, pos, 1f, true); } public void PlayVideo(byte[] raw, int channels, int sampleBits, int sampleRate) { rawSource = LoadSoundRaw(raw, channels, sampleBits, sampleRate); video = soundEngine.Play2D(rawSource, false, true, WPos.Zero, InternalSoundVolume, false); } public void PlayVideo() { if (video != null) soundEngine.PauseSound(video, false); } public void PauseVideo() { if (video != null) soundEngine.PauseSound(video, true); } public void StopVideo() { if (video != null) soundEngine.StopSound(video); } public void Tick() { // Song finished if (MusicPlaying && !music.Playing) { StopMusic(); onMusicComplete(); } } Action onMusicComplete; public bool MusicPlaying { get; private set; } public MusicInfo CurrentMusic { get { return currentMusic; } } public void PlayMusic(MusicInfo m) { PlayMusicThen(m, () => { }); } public void PlayMusicThen(MusicInfo m, Action then) { if (m == null || !m.Exists) return; onMusicComplete = then; if (m == currentMusic && music != null) { soundEngine.PauseSound(music, false); MusicPlaying = true; return; } StopMusic(); var sound = sounds[m.Filename]; if (sound == null) return; music = soundEngine.Play2D(sound, false, true, WPos.Zero, MusicVolume, false); currentMusic = m; MusicPlaying = true; } public void PlayMusic() { if (music == null) return; MusicPlaying = true; soundEngine.PauseSound(music, false); } public void StopSound(ISound sound) { if (sound != null) soundEngine.StopSound(sound); } public void StopMusic() { if (music != null) soundEngine.StopSound(music); MusicPlaying = false; currentMusic = null; } public void PauseMusic() { if (music == null) return; MusicPlaying = false; soundEngine.PauseSound(music, true); } public float GlobalVolume { get { return soundEngine.Volume; } set { soundEngine.Volume = value; } } float soundVolumeModifier = 1.0f; public float SoundVolumeModifier { get { return soundVolumeModifier; } set { soundVolumeModifier = value; soundEngine.SetSoundVolume(InternalSoundVolume, music, video); } } float InternalSoundVolume { get { return SoundVolume * soundVolumeModifier; } } public float SoundVolume { get { return Game.Settings.Sound.SoundVolume; } set { Game.Settings.Sound.SoundVolume = value; soundEngine.SetSoundVolume(InternalSoundVolume, music, video); } } public float MusicVolume { get { return Game.Settings.Sound.MusicVolume; } set { Game.Settings.Sound.MusicVolume = value; if (music != null) music.Volume = value; } } public float VideoVolume { get { return Game.Settings.Sound.VideoVolume; } set { Game.Settings.Sound.VideoVolume = value; if (video != null) video.Volume = value; } } public float MusicSeekPosition { get { return music != null ? music.SeekPosition : 0; } } public float VideoSeekPosition { get { return video != null ? video.SeekPosition : 0; } } // Returns true if played successfully public bool PlayPredefined(Ruleset ruleset, Player p, Actor voicedActor, string type, string definition, string variant, bool relative, WPos pos, float volumeModifier, bool attenuateVolume) { if (ruleset == null) throw new ArgumentNullException("ruleset"); if (definition == null) return false; if (ruleset.Voices == null || ruleset.Notifications == null) return false; var rules = (voicedActor != null) ? ruleset.Voices[type] : ruleset.Notifications[type]; if (rules == null) return false; var id = voicedActor != null ? voicedActor.ActorID : 0; string clip; var suffix = rules.DefaultVariant; var prefix = rules.DefaultPrefix; if (voicedActor != null) { if (!rules.VoicePools.Value.ContainsKey(definition)) throw new InvalidOperationException("Can't find {0} in voice pool.".F(definition)); clip = rules.VoicePools.Value[definition].GetNext(); } else { if (!rules.NotificationsPools.Value.ContainsKey(definition)) throw new InvalidOperationException("Can't find {0} in notification pool.".F(definition)); clip = rules.NotificationsPools.Value[definition].GetNext(); } if (string.IsNullOrEmpty(clip)) return false; if (variant != null) { if (rules.Variants.ContainsKey(variant) && !rules.DisableVariants.Contains(definition)) suffix = rules.Variants[variant][id % rules.Variants[variant].Length]; if (rules.Prefixes.ContainsKey(variant) && !rules.DisablePrefixes.Contains(definition)) prefix = rules.Prefixes[variant][id % rules.Prefixes[variant].Length]; } var name = prefix + clip + suffix; if (!string.IsNullOrEmpty(name) && (p == null || p == p.World.LocalPlayer)) soundEngine.Play2D(sounds[name], false, relative, pos, InternalSoundVolume * volumeModifier, attenuateVolume); return true; } public bool PlayNotification(Ruleset rules, Player player, string type, string notification, string variant) { if (rules == null) throw new ArgumentNullException("rules"); if (type == null || notification == null) return false; return PlayPredefined(rules, player, null, type.ToLowerInvariant(), notification, variant, true, WPos.Zero, 1f, false); } public void Dispose() { soundEngine.Dispose(); } } }