Merge lp:~mgiuca/dosbox/fluidsynth into lp:~mgiuca/dosbox/trunk

[Matt Giuca]

Added a new MIDI driver 'fluidsynth', for DOSBox to send MIDI commands directly to the FluidSynth API.

Added a new MIDI driver 'fluidsynth', which allows DOSBox's MPU-401 MIDI system to talk directly to the FluidSynth software synthesiser API, rather than sending MIDI commands to the system.

This provides a reliable software synthesiser back-end for DOSBox without having to manually set up a FluidSynth server and work out the correct ALSA port.

Unmerged revisions

3696. By Matt Giuca on 2012-03-07

midi: Move FluidSynth to the top, so it is searched last when searching for the default driver.

3695. By Matt Giuca on 2012-03-07

midi_fluidsynth: Formatting to conform to DOSBox coding style.

3694. By Matt Giuca on 2012-03-07

midi_fluidsynth: The 'midiconfig' for this driver now contains the driver:soundfont pair separated by a colon.
This allows the user to specify the FluidSynth audio driver; it is no longer hard-coded to alsa.

3693. By Matt Giuca on 2012-03-06

midi_fluidsynth: Implemented PlaySysex and PlayMsg.
MIDI messages are now routed through to the FluidSynth API, so it all works.

3692. By Matt Giuca on 2012-03-06

midi_fluidsynth: Implemented Open and Close.
Now creates and destroys the FluidSynth driver, loading the soundfont from midiconfig.

3691. By Matt Giuca on 2012-03-06

gui/midi: Only include fluidsynth driver if HAVE_FLUID is defined.

3690. By Matt Giuca on 2012-03-06

Added FluidSynth to build scripts.

3689. By Matt Giuca on 2012-03-06

Added fluidsynth as a type of mididevice.
Currently just stubs (logs all method calls).

3688. By qbix79 on 2012-01-27

Add patch 3461824: Readme fixes by clem

3687. By qbix79 on 2012-01-27

Add cmd-q => exit for Mac OS X

=== modified file 'acinclude.m4'
--- acinclude.m4	2011-04-26 09:34:55 +0000
+++ acinclude.m4	2012-03-07 05:50:24 +0000
@@ -303,6 +303,126 @@
 AC_SUBST(ALSA_LIBS)
 ])
 
+dnl Configure Paths for FluidSynth
+dnl Modified from the ALSA code above by Matt Giuca <[e-mail]>
+dnl Test for libfluidsynth, and define FLUID_CFLAGS and FLUID_LIBS as
+dnl appropriate.
+dnl AM_PATH_FLUID([MINIMUM-VERSION [, ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]])
+dnl enables arguments --with-fluid-prefix=
+dnl                   --with-fluid-inc-prefix=
+dnl
+dnl For backwards compatibility, if ACTION_IF_NOT_FOUND is not specified,
+dnl and the FluidSynth libraries are not found, a fatal AC_MSG_ERROR() will
+dnl result.
+dnl
+AC_DEFUN([AM_PATH_FLUID],
+[dnl Save the original CFLAGS, LDFLAGS, and LIBS
+fluid_save_CFLAGS="$CFLAGS"
+fluid_save_LDFLAGS="$LDFLAGS"
+fluid_save_LIBS="$LIBS"
+fluid_found=yes
+
+dnl
+dnl Get the cflags and libraries for fluidsynth
+dnl
+AC_ARG_WITH(fluid-prefix,
+[  --with-fluid-prefix=PFX  Prefix where FluidSynth library is installed (optional)],
+[fluid_prefix="$withval"], [fluid_prefix=""])
+
+AC_ARG_WITH(fluid-inc-prefix,
+[  --with-fluid-inc-prefix=PFX  Prefix where include libraries are (optional)],
+[fluid_inc_prefix="$withval"], [fluid_inc_prefix=""])
+
+dnl Add any special include directories
+AC_MSG_CHECKING(for FluidSynth CFLAGS)
+if test "$fluid_inc_prefix" != "" ; then
+	FLUID_CFLAGS="$FLUID_CFLAGS -I$fluid_inc_prefix"
+	CFLAGS="$CFLAGS -I$fluid_inc_prefix"
+fi
+AC_MSG_RESULT($FLUID_CFLAGS)
+
+dnl add any special lib dirs
+AC_MSG_CHECKING(for FluidSynth LDFLAGS)
+if test "$fluid_prefix" != "" ; then
+	FLUID_LIBS="$FLUID_LIBS -L$fluid_prefix"
+	LDFLAGS="$LDFLAGS $FLUID_LIBS"
+fi
+
+dnl add the fluidsynth library
+FLUID_LIBS="$FLUID_LIBS -lfluidsynth"
+LIBS="$FLUID_LIBS $LIBS"
+AC_MSG_RESULT($FLUID_LIBS)
+
+dnl Check for a working version of libfluidsynth that is of the right version.
+min_fluid_version=ifelse([$1], ,1.1.2,$1)
+AC_MSG_CHECKING(for libfluidsynth headers version >= $min_fluid_version)
+no_fluid=""
+    fluid_min_major_version=`echo $min_fluid_version | \
+           sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\1/'`
+    fluid_min_minor_version=`echo $min_fluid_version | \
+           sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\2/'`
+    fluid_min_micro_version=`echo $min_fluid_version | \
+           sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\3/'`
+
+AC_LANG_SAVE
+AC_LANG_C
+AC_TRY_COMPILE([
+#include <fluidsynth.h>
+], [
+#  if(FLUIDSYNTH_VERSION_MAJOR > $fluid_min_major_version)
+  exit(0);
+#  else
+#    if(FLUIDSYNTH_VERSION_MAJOR < $fluid_min_major_version)
+#       error not present
+#    endif
+
+#   if(FLUIDSYNTH_VERSION_MINOR > $fluid_min_minor_version)
+  exit(0);
+#   else
+#     if(FLUIDSYNTH_VERSION_MINOR < $fluid_min_minor_version)
+#          error not present
+#      endif
+
+#      if(FLUIDSYNTH_VERSION_MICRO < $fluid_min_micro_version)
+#        error not present
+#      endif
+#    endif
+#  endif
+exit(0);
+],
+  [AC_MSG_RESULT(found.)],
+  [AC_MSG_RESULT(not present.)
+   ifelse([$3], , [AC_MSG_ERROR(Sufficiently new version of libfluidsynth not found.)])
+   fluid_found=no]
+)
+AC_LANG_RESTORE
+
+dnl Now that we know that we have the right version, let's see if we have the library and not just the headers.
+AC_CHECK_LIB([fluidsynth], [new_fluid_synth],,
+	[ifelse([$3], , [AC_MSG_ERROR(No linkable libfluidsynth was found.)])
+	 fluid_found=no]
+)
+
+if test "x$fluid_found" = "xyes" ; then
+   ifelse([$2], , :, [$2])
+   LIBS=`echo $LIBS | sed 's/-lfluidsynth//g'`
+   LIBS=`echo $LIBS | sed 's/  //'`
+   LIBS="-lfluidsynth $LIBS"
+fi
+if test "x$fluid_found" = "xno" ; then
+   ifelse([$3], , :, [$3])
+   CFLAGS="$fluid_save_CFLAGS"
+   LDFLAGS="$fluid_save_LDFLAGS"
+   LIBS="$fluid_save_LIBS"
+   FLUID_CFLAGS=""
+   FLUID_LIBS=""
+fi
+
+dnl That should be it.  Now just export out symbols:
+AC_SUBST(FLUID_CFLAGS)
+AC_SUBST(FLUID_LIBS)
+])
+
 AH_TOP([
 /*
  *  Copyright (C) 2002-2011  The DOSBox Team

=== modified file 'configure.in'
--- configure.in	2011-06-12 13:58:27 +0000
+++ configure.in	2012-03-07 05:50:24 +0000
@@ -182,6 +182,19 @@
   CXXFLAGS="$CXXFLAGS $ALSA_CFLAGS"
 fi
 
+dnl enable disable fluidsynth and pass it's cflags to CXXFLAGS
+AC_ARG_ENABLE(fluidsynth-midi,
+AC_HELP_STRING([--enable-fluidsynth-midi],[compile with fluidsynth midi support (default yes)]),
+[ case "${enableval}" in
+ yes) fluid_midi=true;;
+ no)  fluid_midi=false;;
+esac],
+[fluid_midi=true])
+if test x$fluid_midi = xtrue ; then 
+  AM_PATH_FLUID(1.1.2, AC_DEFINE(HAVE_FLUID,1,[Define to 1 to use FluidSynth for MIDI]) , : )
+  CXXFLAGS="$CXXFLAGS $FLUID_CFLAGS"
+fi
+
 #Check for big endian machine, should #define WORDS_BIGENDIAN if so
 AC_C_BIGENDIAN
 

=== modified file 'src/dosbox.cpp'
--- src/dosbox.cpp	2011-11-01 17:00:19 +0000
+++ src/dosbox.cpp	2012-03-07 05:50:24 +0000
@@ -480,7 +480,7 @@
 	
 	const char* mputypes[] = { "intelligent", "uart", "none",0};
 	// FIXME: add some way to offer the actually available choices.
-	const char *devices[] = { "default", "win32", "alsa", "oss", "coreaudio", "coremidi","none", 0};
+	const char *devices[] = { "default", "win32", "alsa", "oss", "fluidsynth", "coreaudio", "coremidi","none", 0};
 	Pstring = secprop->Add_string("mpu401",Property::Changeable::WhenIdle,"intelligent");
 	Pstring->Set_values(mputypes);
 	Pstring->Set_help("Type of MPU-401 to emulate.");
@@ -491,7 +491,7 @@
 
 	Pstring = secprop->Add_string("midiconfig",Property::Changeable::WhenIdle,"");
 	Pstring->Set_help("Special configuration options for the device driver. This is usually the id of the device you want to use.\n"
-	                  "  or in the case of coreaudio, you can specify a soundfont here.\n"
+	                  "  or in the case of coreaudio or fluidsynth, you can specify a soundfont here.\n"
 	                  "  When using a Roland MT-32 rev. 0 as midi output device, some games may require a delay in order to prevent 'buffer overflow' issues.\n"
 	                  "  In that case, add 'delaysysex', for example: midiconfig=2 delaysysex\n"
 	                  "  See the README/Manual for more details.");

=== modified file 'src/gui/midi.cpp'
--- src/gui/midi.cpp	2011-04-26 09:34:55 +0000
+++ src/gui/midi.cpp	2012-03-07 05:50:24 +0000
@@ -82,6 +82,12 @@
 
 /* Include different midi drivers, lowest ones get checked first for default */
 
+#if defined (HAVE_FLUID)
+
+#include "midi_fluidsynth.h"
+
+#endif
+
 #if defined(MACOSX)
 
 #include "midi_coremidi.h"

=== added file 'src/gui/midi_fluidsynth.h'
--- src/gui/midi_fluidsynth.h	1970-01-01 00:00:00 +0000
+++ src/gui/midi_fluidsynth.h	2012-03-07 05:50:24 +0000
@@ -0,0 +1,137 @@
+/*
+ *  Copyright (C) 2002-2011  The DOSBox Team
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#include <fluidsynth.h>
+#include <ctype.h>
+#include <string>
+#include <sstream>
+
+class MidiHandler_fluidsynth : public MidiHandler {
+private:
+	std::string audio_driver;
+	std::string soundfont;
+	int soundfont_id;
+	fluid_settings_t *settings;
+	fluid_synth_t *synth;
+	fluid_audio_driver_t* adriver;
+public:
+	MidiHandler_fluidsynth() : MidiHandler() {};
+	const char* GetName(void) { return "fluidsynth"; }
+	void PlaySysex(Bit8u * sysex,Bitu len) {
+		fluid_synth_sysex(synth, (char*) sysex, len, NULL, NULL, NULL, 0);
+	}
+
+	void PlayMsg(Bit8u * msg) {
+		unsigned char chanID = msg[0] & 0x0F;
+		switch (msg[0] & 0xF0) {
+		case 0x80:
+			fluid_synth_noteoff(synth, chanID, msg[1]);
+			break;
+		case 0x90:
+			fluid_synth_noteon(synth, chanID, msg[1], msg[2]);
+			break;
+		case 0xB0:
+			fluid_synth_cc(synth, chanID, msg[1], msg[2]);
+			break;
+		case 0xC0:
+			fluid_synth_program_change(synth, chanID, msg[1]);
+			break;
+		case 0xD0:
+			fluid_synth_channel_pressure(synth, chanID, msg[1]);
+			break;
+		case 0xE0:{
+				long theBend = ((long)msg[1] + (long)(msg[2] << 7));
+				fluid_synth_pitch_bend(synth, chanID, theBend);
+			}
+			break;
+		default:
+			LOG(LOG_MISC,LOG_WARN)("MIDI:fluidsynth: Unknown Command: %08lx", (long)msg);
+			break;
+		}
+	}	
+
+	void Close(void) {
+		if (soundfont_id >= 0) {
+			fluid_synth_sfunload(synth, soundfont_id, 0);
+		}
+		delete_fluid_audio_driver(adriver);
+		delete_fluid_synth(synth);
+		delete_fluid_settings(settings);
+	}
+
+	bool Open(const char * conf) {
+		/* The 'midiconfig' for the fluidsynth driver is a string of the
+		 * following format:
+		 * audio_driver:soundfont
+		 * The audio_driver is the name of the FluidSynth audio driver (e.g.,
+		 * "jack" or "alsa"). The soundfont is the filename to the soundfont
+		 * to load.
+		 * If there is no colon, the whole string is the driver, and no
+		 * soundfont is loaded. If midiconfig is missing or empty, the driver
+		 * is the default.
+		 */
+		if (conf && conf[0]) {
+			std::string conf_str(conf);
+			size_t delim_pos = conf_str.find(':');
+			if (delim_pos == std::string::npos) {
+				/* No colon; whole string is driver */
+				audio_driver = conf_str;
+			} else {
+				/* Split string based on position of colon */
+				audio_driver.assign(conf_str, 0, delim_pos);
+				soundfont.assign(conf_str.c_str() + delim_pos + 1);
+			}
+		}
+		settings = new_fluid_settings();
+		if (!audio_driver.empty()) {
+			fluid_settings_setstr(settings, "audio.driver", audio_driver.c_str());
+		}
+		synth = new_fluid_synth(settings);
+		if (!synth) {
+			LOG_MSG("MIDI:fluidsynth: Can't open synthesiser");
+			delete_fluid_settings(settings);
+			return false;
+		}
+		adriver = new_fluid_audio_driver(settings, synth);
+		if (!adriver) {
+			LOG_MSG("MIDI:fluidsynth: Can't create audio driver");
+			delete_fluid_synth(synth);
+			delete_fluid_settings(settings);
+			return false;
+		}
+
+		/* Optionally load a soundfont */
+		if (!soundfont.empty()) {
+			soundfont_id = fluid_synth_sfload(synth, soundfont.c_str(), 1);
+			if (soundfont_id == FLUID_FAILED) {
+				/* Just consider this a warning (fluidsynth already prints) */
+				soundfont.clear();
+				soundfont_id = -1;
+			} else {
+				LOG_MSG("MIDI:fluidsynth: loaded soundfont: %s",
+					soundfont.c_str());
+			}
+		} else {
+			soundfont_id = -1;
+			LOG_MSG("MIDI:fluidsynth: no soundfont loaded");
+		}
+		return true;
+	}
+};
+
+MidiHandler_fluidsynth Midi_fluidsynth;