Topic: SoundSense: a sound engine for dwarf fortress. (Read 573902 times)

NRN_R_Sumo1 · « **Reply #15 on:** June 27, 2010, 07:31:24 pm »

if you want I could take my hand at making some sounds digitally, I'm by no means a professional but I should be able to come up with the majority of what you'd want.

Diablous · « **Reply #16 on:** June 27, 2010, 07:32:53 pm »

Nice idea. I like.

sphr · « **Reply #17 on:** June 27, 2010, 09:12:44 pm »

Lol.. i did a quick try on combat sounds..... the result is.... interesting.... (I just chose loops anyhow from the soundbible site included in the original config file...) It's not exhaustive, but at least now when somebody "strikes" (there are other verbs which I did not include) or shoots a projectile, some sound will roll...

test run combat sounds

Spoiler (click to show/hide)

Intruders (less siege, coz siege not logged somehow..... strange....)

Spoiler (click to show/hide)

Mandates (demands not included)

Spoiler (click to show/hide)

something reach adulthood (animals or dwarves) + manager task or masterpiece compelted

Spoiler (click to show/hide)

Strange mood.... (love the evil laugh cackle... LOL)

Spoiler (click to show/hide)

Deaths (very incomplete.... so many ways to die in DF...)

Spoiler (click to show/hide)

Seasons

Spoiler (click to show/hide)

nefty · « **Reply #18 on:** June 27, 2010, 10:58:24 pm »

http://opengameart.org/browse/audio

This might be a good resource for sound effects and music. I haven't really looked thoroughly but I'm sure there's some good stuff in there.

Robsoie · « **Reply #19 on:** June 27, 2010, 11:36:25 pm »

Last time my woodcutter UristMcInsane has gone berserk inside of my fortress while carrying his axe, i could really imagine this music being played.
http://www.youtube.com/watch?v=JcNhDstL4-k

That's a great tool if we can add sounds for the events.

Bloogonis · « **Reply #20 on:** June 28, 2010, 12:04:15 am »

I am definitely keeping an eye on this

NieXS · « **Reply #21 on:** June 28, 2010, 12:14:12 am »

I got inspired by this, and found several fitting background songs for seasons, sieges, ambushes and menus. I also wrote my own version of it, using SDL (actually two versions: one in Ruby, which isn't really portable to Windows due to requiring the whole language runtime, and one in Vala, but I couldn't get sound effects to work there, somehow). The Vala version would be lighter than this, due to not requiring the Java runtime (Vala compiles to C, which compiles to machine code). All of the songs were found in incompetech.com, except for the sound effects, which I took from this app for testing. The songs:

Spoiler (click to show/hide)

Code: [Select]

<events>
	<event pattern="^(Spring has arrived|The wet season)">
		<music>For Originz.ogg</music>
		<stateful/>
	</event>
	<event pattern="^(It is now summer\.$|Summer has arrived)">
		<music>Exciting Trailer.ogg</music>
		<stateful/>
	</event>
	<event pattern="^(Autumn has (come\.|arrived)|The dry season)">
		<music>Rains Will Fall.ogg</music>
		<stateful/>
	</event>
	<event pattern="^Winter (is|has)">
		<music>Frost Waltz.ogg</music>
		<stateful/>
	</event>
	<event pattern="^\*\* (Loading Fortress|Starting New Outpost)">
		<music>Heavy Interlude.ogg</music>
		<stateful/>
	</event>
	<event pattern="^\*\*\* STARTING NEW GAME">
		<music>song_title.ogg</music> <!-- DF's -->
		<stateful/>
	</event>
	<event pattern="^An ambush!">
		<music>Clenched Teeth.ogg</music>
	</event>
	<event pattern="^A vile force of darkness">
		<music>Clenched Teeth.ogg</music>
		<music>Final Count.ogg</music>
		<music>Faceoff.ogg</music>
	</event>
	<event pattern="^It has started raining.">
		<sfx>Distant Thunder And Light Rain-SoundBible.com-148277450.ogg</sfx>
		<sfx>Lightning Strike Summer Storm-SoundBible.com-1070450923.ogg</sfx>
	</event>
	<event pattern="has given birth">
		<sfx>Child Scream-SoundBible.com-1951741114.ogg</sfx>
	</event>
	<event pattern="^A snow storm has come.">
		<sfx>Snowing-SoundBible.com-495580994.ogg</sfx>
	</event>
	<event pattern=".+ cancels .+: .+">
		<sfx>Drop Metal Thing-SoundBible.com-401640954.ogg</sfx>
	</event>
</events>

The Ruby version:

Spoiler (click to show/hide)

Code: [Select]

#!/usr/bin/ruby
require 'sdl'
require 'yaml'
require 'iconv'

class DFSound
	def initialize() 
		puts "DFSound 0.1"
		puts "Copyright (c) 2010 NieXS - All rights reserved."
		puts "See the file LICENSE for licensing information."
		puts ""
		puts "Starting up..."
		puts "Starting up SDL..."
		# Setting up SDL
		SDL.init(SDL::INIT_AUDIO)
		SDL::Mixer.open(44010,SDL::Mixer::DEFAULT_FORMAT,2,512)
		# Sound effects
		@sfx   = []
		# Loading up the events.
		puts "Loading events..."
		@events = YAML::load(open('events.yml')) || []
		@current_stateful_event = nil
		# gamelog.txt
		puts "Loading game log..."
		@gamelog = File.open(ARGV[0],'a+')
		@gamelog.seek(0,IO::SEEK_END)
		puts "Ready."
	end
	
	def main_loop()
		puts "Starting main loop..."
		while true
			line = @gamelog.gets
			begin
				line = Iconv.conv("UTF-8","ISO-8859-1",line)
			rescue Exception
				next
			end
			if line.nil? # ie, EOF
				# Wait.
				sleep 0.1
			else
				for event in @events
					begin
						if Regexp.new(event['pattern']) =~ line
							begin
								if event['stateful']
									@current_stateful_event = event
								end
								if event['music']
									if event['music'].kind_of?(Array)
										music = event['music'].shuffle[0]
									else
										music = event['music']
									end
									music = SDL::Mixer::Music.load('music/'+music)
									SDL::Mixer.play_music(music,1)
								end
								if event['sfx']
									if event['sfx'].kind_of?(Array)
										sfx = event['sfx'].shuffle[0]
									else
										sfx = event['sfx']
									end
									sfx   = SDL::Mixer::Wave.load('sfx/'+sfx)
									SDL::Mixer.play_channel(-1,sfx,0)
								end
							rescue SDL::Error
								puts "---ERROR---"
								puts "The event for the pattern \"#{event['pattern']}\" has missing/unssuported music or sound effects."
								exit 1
							end
							break
						end
					rescue SignalException
						exit 0
					rescue RegexpError
						puts "---ERROR---"
						puts "Broken pattern: #{event['pattern']}"
						exit 1
					end
				end
			end
			# Implementation for stateful events
			if !SDL::Mixer.play_music? && @current_stateful_event
				if @current_stateful_event['music'].kind_of?(Array)
					music = @current_stateful_event['music'].shuffle[0]
				else
					music = @current_stateful_event['music']
				end
				music = SDL::Mixer::Music.load('music/'+music)
				SDL::Mixer.play_music(music,0)
			end
		end
	end
end

if __FILE__ == $0
	DFSound.new.main_loop
end

Vala version:

Spoiler (click to show/hide)

Code: [Select]

errordomain DFSoundError {
	MISSING_LOG,
	MALFORMED_PATTERN,
	MISSING_PATTERN
}
class DFSound : Object {
	private string[] sound_effects = {};
	private List<Event> events = new List<Event>();
	private Event current_stateful_event;
	private DataInputStream gamelog;
	private SDLMixer.Music music;
	
	private class Event {
		public string pattern;
		public string[] music;
		public string[] sfx;
		public bool stateful;
		public Event(string? pattern,string?[] music,string?[] sfx,bool stateful) {
			this.pattern  = pattern;
			this.music    = music;
			this.sfx      = sfx;
			this.stateful = stateful;
		}
	}
	
	public DFSound(string[] args) {
		print("DFSound 0.1\n");
		print("Copyright (c) 2010 NieXS - All rights reserved.\n");
		print("See the file LICENSE for licensing information.\n");
		print("\n");
		print("Starting up...\n");
		print("Starting up SDL...\n");
		SDL.init(SDL.InitFlag.AUDIO);
		SDLMixer.open(44010,SDL.AudioFormat.S16,2,512);
		print("Loading events...\n");
		Xml.Parser.init();
		Xml.Doc* doc = Xml.Parser.parse_file("events.xml");
		Xml.Node* root = doc->get_root_element();
		for(Xml.Node* node = root->children;node != null; node = node->next) {
			if(node->type != Xml.ElementType.ELEMENT_NODE) continue;
			string pattern = node->get_prop("pattern");
			if(pattern != null) {
				try {
					new Regex(pattern);
				} catch(RegexError e) {
					throw new DFSoundError.MALFORMED_PATTERN(pattern);
				}
			} else {
				throw new DFSoundError.MISSING_PATTERN("Missing pattern");
			}
			string[] music = {};
			string[] sfx = {};
			bool stateful = false;
			for(Xml.Node* child = node->children;child != null; child = child->next) {
				if(node->type != Xml.ElementType.ELEMENT_NODE) continue;
				if(child->name == "music") {
					music += child->get_content();
					print(child->get_content()+"\n");
				} else if(child->name == "sfx") {
					sfx += child->get_content();
					print(child->get_content()+"\n");
				} else if(child->name == "stateful") {
					stateful = true;
				}
			}
			events.append(new Event(pattern,music,sfx,stateful));
		}
		print("Opening game log...\n");
		File gamelog_file = File.new_for_path(args[1]);
		if(!gamelog_file.query_exists(null)) {
			print("---ERROR---\n");
			print("Could not open game log for some reason. Check the path.\n");
			throw new DFSoundError.MISSING_LOG("missing log");
		}
		gamelog = new DataInputStream(gamelog_file.read(null));
		// Seeking... ugly hack, but DataInputStream lacks a seeking function
		while(gamelog.read_line(null,null) != null);
		print("Ready.\n");
	}
	
	public void main_loop() {
		while(true) {
			string line = gamelog.read_line(null,null);
			if(line != null) {
				line = convert(line,(ssize_t)line.size(),"UTF-8","ISO-8859-1");
				assert(line.validate());
				print(line+"\n");
				foreach(Event event in events) {
					if(Regex.match_simple(event.pattern,line)) {
						print("Found event\n");
						if(event.stateful) {
							current_stateful_event = event;
						}
						if(event.music.length != 0) {
							print("Playing music\n");
							string music = event.music[Random.int_range(0,event.music.length)];
							this.music = new SDLMixer.Music("music/"+music);
							this.music.play(0);
						}
						if(event.sfx.length != 0) {
							print("Playing sfx\n");
							string sfx_fname = event.sfx[Random.int_range(0,event.sfx.length)];
							SDLMixer.Chunk sfx = new SDLMixer.Chunk.WAV(new SDL.RWops.from_file("sfx/"+sfx_fname,"r"));
							SDLMixer.play(-1,sfx,0);
						}
						break;
					}
				}
			} else {
				Posix.usleep(100);
			}
			if(SDLMixer.Music.is_playing() != 1 && current_stateful_event != null) {
				string music = current_stateful_event.music[Random.int_range(0,current_stateful_event.music.length)];
				this.music = new SDLMixer.Music("music/"+music);
				this.music.play(1);
			}
			print(SDL.get_error());
		}
	}
}
int main(string[] args) {
	Random.set_seed((uint32)time_t());
	DFSound dfs = new DFSound(args);
	dfs.main_loop();
	return 0;
}

zwei · « **Reply #22 on:** June 28, 2010, 12:58:08 am »

Quote from: Grimlocke on June 27, 2010, 03:23:43 pm

...

You could resolve the legalty issue by letting the user select the music to play for certain situations.

As said, it is possible, but well see about that.

As far as legality goes, my issue is that i could not make pack with license-burdened sounds and music and let users download it.

They can, of course, get it somewhere else and add it maually, but that is not really ideal. Were not elven hippies!

Quote from: sphr on June 27, 2010, 04:09:31 pm

Interesting, and potentially useful as well. (at the least, on a dual monitor, it can function as a log reader! LOL)

Just a thought, using the log reader as a core, it could potentially be redesigned as a general framework log reader, which parses the log messages back into events...

That is a bit more than what I wanted to achieve, but once core of what i want to do is up ad running (sounds), it ca be expanded a lot.

I would, however take a hint from you and redesign xml format a bit for potetial extensions per your ideas.

Quote from: Prastary on June 27, 2010, 04:44:05 pm

Btw, what impact does it have on performance, if any? I have an very old computer.

Well, it is mp3 playback on top of what DF does, impack should be minimal (if you listen to music while playing it should be about same) and with dual-core, it should be near zero.

If game events become too spammy, it could cause major slowdowns, but I have plans to detect "log spam" and start dropping certain sounds (playing sounds for 20 interrupt messages at once is not going to sound good either...)

Quote from: Shadetree on June 27, 2010, 06:41:59 pm

http://www.freesound.org/ might have some good stuffs.

Could you hook into a Text to Speech library? If so that would be useful as well.

Thanks for link.

Text for speech ... hm, it did not occur to me, but sure, can do that. Neat idea!

Quote from: NRN_R_Sumo1 on June 27, 2010, 07:31:24 pm

if you want I could take my hand at making some sounds digitally, I'm by no means a professional but I should be able to come up with the majority of what you'd want.

That would be helpfull, thanks. I am not sure what we want yet or how mood should be set (spoken messages? various dings? natural sounds?), but feel free to come up with some ideas.

Quote from: sphr on June 27, 2010, 09:12:44 pm

Lol.. i did a quick try on combat sounds..... the result is.... interesting....

Whoa, great job! So, how does combat sound

?

This reminds me that we need separate config files for different sound libraries so that they can be added/removed easily without much hassle.

Quote from: nefty on June 27, 2010, 10:58:24 pm

http://opengameart.org/browse/audio

Thanks! Took a small peek and it seems that it would be great source for combat sounds.

Quote from: NieXS on June 28, 2010, 12:14:12 am

I got inspired by this, ... I also wrote my own version of it, ...

A competition! Splendid!

We should agree on xml file format so that people do not need to make two version of their pack or be forced to convert from one to another.

Praetyre · « **Reply #23 on:** June 28, 2010, 01:00:47 am »

This one's fairly old, but I believe the OP is still active. Might want to look into contacting him for the necessary permissions: http://www.bay12forums.com/smf/index.php?topic=37469

zwei · « **Reply #24 on:** June 28, 2010, 02:47:20 am »

New release:

release: http://df.zweistein.cz/pub/soundSense_2_8.zip
source: http://df.zweistein.cz/pub/soundSense_2_8_src.zip

New features:
* Loop and Music flags in configuration
* Extended configuration (multiple files in directory supported to ease creating packages)
* Added sphr's battle sounds (as example package)
* Commandline parameters for config dir and gamelog locations.

zwei · « **Reply #25 on:** June 28, 2010, 11:07:05 am »

r3 released:
* Logging is cleaner now
* Looped music now picks one of random alternate tracks.
* Added some mandate, mood sounds and intruder sounds and placeholders.
* Finalized seasonal background tracks.
* Fixed bug with sound that has zero files.

This one is bitch (as far as size is concerned), soundtrack makes it weight 30MB (is it record for df tool or what?), So i uploaded it to rapidshare: http://rapidshare.com/files/403576379/soundSense_3_9.zip.html

Prastary · « **Reply #26 on:** June 28, 2010, 11:15:23 am »

Thank you for your work!

Prastary · « **Reply #27 on:** June 29, 2010, 03:31:19 am »

bump. I have played yesterday DF with soundsense and must say that it is one of the best additions to the game. It adds even more climate. Waiting impatiently for updates!

sphr · « **Reply #28 on:** June 29, 2010, 05:47:29 am »

Yeah. This is another tool that really really helps bring attentions to events, so that I can actually do something else like browse web while I left DF running elsewhere...

My favorite is a kitty alert I set to play a kitten's meow when a kitten is born.... so that it can be caged... keeps cats from taking over the colony. And also improved my own battle sounds to catch more attack types... lol... really helps to bring attention to combat somewhere.

One thing, if I may suggest: separate the core files (with possibly sample xml + a few sample files) from the sound "theme" pack. That should make it possible to host the core file somewhere other than rapidshare.... which I had problems with...

gimme r3... (or newer version??)

Another possible suggestion: maybe it's time to put in an options file to set the base for some user options (e.g. customize the logger to display or hide debug messages (or just display the line from log file as is) which may not be of interest to those who use the run window as a real-time log viewer, like me!!

) Also : the quality symbols sometimes messes up the console display... may want to escape/replace the string before output to console...

Edit: AHHHHH forgot the most improtant thing!!!!
An excellent job well done, zwei! You've provided an innovative avenue to significant improvements to the DF experience!

zwei · « **Reply #29 on:** June 29, 2010, 07:41:01 am »

Quote from: sphr on June 29, 2010, 05:47:29 am

gimme r3... (or newer version??)

Ask, and you shall recieve:

http://df.zweistein.cz/soundsense/soundSense_4_13.zip

And site with packs which are now much more friendly for installation (just drop unzipped pack directory to "packs" directory):

http://df.zweistein.cz/soundsense/

Don't be shy to share your packs now

News:

Author Topic: SoundSense: a sound engine for dwarf fortress. (Read 573902 times)

NRN_R_Sumo1

Re: SoundSense: a sound engine for dwarf fortress.

Diablous

Re: SoundSense: a sound engine for dwarf fortress.

sphr

Re: SoundSense: a sound engine for dwarf fortress.

nefty

Re: SoundSense: a sound engine for dwarf fortress.

Robsoie

Re: SoundSense: a sound engine for dwarf fortress.

Bloogonis

Re: SoundSense: a sound engine for dwarf fortress.

NieXS

Re: SoundSense: a sound engine for dwarf fortress.

zwei

Re: SoundSense: a sound engine for dwarf fortress.

Praetyre

Re: SoundSense: a sound engine for dwarf fortress.

zwei

Re: SoundSense: a sound engine for dwarf fortress.

zwei

Re: SoundSense: a sound engine for dwarf fortress.

Prastary

Re: SoundSense: a sound engine for dwarf fortress.

Prastary

Re: SoundSense: a sound engine for dwarf fortress.

sphr

Re: SoundSense: a sound engine for dwarf fortress.

zwei

Re: SoundSense: a sound engine for dwarf fortress.