Add JACK utility functions in libardour and test

This contains much of the code present in the GUI EngineDialog class
but refactored with some added windows bits.

2 files changed, 348 insertions, 0 deletions

diff --git a/libs/ardour/test/jack_utils_test.cc b/libs/ardour/test/jack_utils_test.cc
new file mode 100644
index 0000000000..ed80237f78
--- /dev/null
+++ b/libs/ardour/test/jack_utils_test.cc
@@ -0,0 +1,315 @@
+
+#include <stdexcept>
+
+#ifdef WIN32
+#include <windows.h> // only for Sleep
+#endif
+
+#include <glibmm/miscutils.h>
+
+#include "ardour/jack_utils.h"
+
+#include "jack_utils_test.h"
+
+CPPUNIT_TEST_SUITE_REGISTRATION (JackUtilsTest);
+
+using namespace std;
+using namespace ARDOUR;
+
+void
+JackUtilsTest::test_driver_names ()
+{
+	vector<string> driver_names;
+
+	get_jack_audio_driver_names (driver_names);
+
+	CPPUNIT_ASSERT(!driver_names.empty());
+
+	cout << endl;
+	cout << "Number of possible JACK Audio drivers found on this system: " << driver_names.size () << endl;
+
+	for (vector<string>::const_iterator i = driver_names.begin(); i != driver_names.end(); ++i) {
+		cout << "JACK Audio driver found: " << *i << endl;
+	}
+
+	string default_audio_driver;
+	get_jack_default_audio_driver_name (default_audio_driver);
+
+	cout << "The default audio driver on this system is: " << default_audio_driver << endl;
+
+	driver_names.clear();
+
+	get_jack_midi_system_names (default_audio_driver, driver_names);
+
+	CPPUNIT_ASSERT(!driver_names.empty());
+
+	cout << "Number of possible JACK MIDI drivers found on this system for default audio driver: " << driver_names.size () << endl;
+
+	for (vector<string>::const_iterator i = driver_names.begin(); i != driver_names.end(); ++i) {
+		cout << "JACK MIDI driver found: " << *i << endl;
+	}
+
+	string default_midi_driver;
+	get_jack_default_midi_system_name (default_audio_driver, default_midi_driver);
+
+	cout << "The default midi driver on this system is: " << default_midi_driver << endl;
+}
+
+string
+devices_string (const vector<string>& devices)
+{
+	std::string str;
+	for (vector<string>::const_iterator i = devices.begin(); i != devices.end();) {
+		str += *i;
+		if (++i != devices.end()) str += ", ";
+	}
+	return str;
+}
+
+void
+JackUtilsTest::test_device_names ()
+{
+	vector<string> driver_names;
+
+	get_jack_audio_driver_names (driver_names);
+
+	CPPUNIT_ASSERT(!driver_names.empty());
+
+	cout << endl;
+
+	for (vector<string>::const_iterator i = driver_names.begin(); i != driver_names.end(); ++i) {
+		string devices = devices_string (get_jack_device_names_for_audio_driver (*i));
+		cout << "JACK Audio driver found: " << *i << " with devices: " << devices << endl;
+	}
+}
+
+void
+JackUtilsTest::test_samplerates ()
+{
+	vector<string> samplerates;
+
+	get_jack_sample_rate_strings (samplerates);
+	cout << endl;
+	cout << "Number of possible Samplerates supported by JACK: " << samplerates.size () << endl;
+
+	for (vector<string>::const_iterator i = samplerates.begin(); i != samplerates.end(); ++i) {
+		cout << "Samplerate: " << *i << endl;
+	}
+}
+
+void
+JackUtilsTest::test_period_sizes ()
+{
+	vector<string> period_sizes;
+
+	get_jack_period_size_strings (period_sizes);
+	cout << endl;
+	cout << "Number of possible Period sizes supported by JACK: " << period_sizes.size () << endl;
+
+	for (vector<string>::const_iterator i = period_sizes.begin(); i != period_sizes.end(); ++i) {
+		cout << "Period size: " << *i << endl;
+	}
+}
+
+void
+JackUtilsTest::test_dither_modes ()
+{
+	vector<string> driver_names;
+
+	get_jack_audio_driver_names (driver_names);
+
+	CPPUNIT_ASSERT(!driver_names.empty());
+
+	cout << endl;
+
+	for (vector<string>::const_iterator i = driver_names.begin(); i != driver_names.end(); ++i) {
+		vector<string> dither_modes;
+
+		get_jack_dither_mode_strings (*i, dither_modes);
+		cout << "Number of possible Dither Modes supported by JACK driver " << *i <<
+			": " << dither_modes.size () << endl;
+		for (vector<string>::const_iterator j = dither_modes.begin(); j != dither_modes.end(); ++j) {
+			cout << "Dither Mode: " << *j << endl;
+		}
+		cout << endl;
+	}
+
+}
+
+void
+JackUtilsTest::test_connect_server ()
+{
+	cout << endl;
+	if (jack_server_running ()) {
+		cout << "Jack server running " << endl;
+	} else {
+		cout << "Jack server not running " << endl;
+	}
+}
+
+void
+JackUtilsTest::test_set_jack_path_env ()
+{
+	cout << endl;
+
+	bool path_env_set = false;
+
+	string path_env = Glib::getenv ("PATH", path_env_set);
+
+	if (path_env_set) {
+		cout << "PATH env set to: " << path_env << endl;
+	} else {
+		cout << "PATH env not set" << endl;
+	}
+	vector<string> server_dirs;
+	get_jack_server_dir_paths (server_dirs);
+	set_path_env_for_jack_autostart (server_dirs);
+
+	path_env_set = false;
+
+	path_env = Glib::getenv ("PATH", path_env_set);
+
+	CPPUNIT_ASSERT (path_env_set);
+
+	cout << "After set_jack_path_env PATH env set to: " << path_env << endl;
+}
+
+void
+JackUtilsTest::test_server_paths ()
+{
+	cout << endl;
+
+	vector<std::string> server_dirs;
+
+	CPPUNIT_ASSERT (get_jack_server_dir_paths (server_dirs));
+
+	cout << "Number of Directories that may contain JACK servers: " << server_dirs.size () << endl;
+
+	for (vector<std::string>::const_iterator i = server_dirs.begin(); i != server_dirs.end(); ++i) {
+		cout << "JACK server directory path: " << *i << endl;
+	}
+
+	vector<string> server_names;
+
+	CPPUNIT_ASSERT (get_jack_server_application_names (server_names));
+
+	cout << "Number of possible JACK server names on this system: " << server_names.size () << endl;
+
+	for (vector<string>::const_iterator i = server_names.begin(); i != server_names.end(); ++i) {
+		cout << "JACK server name: " << *i << endl;
+	}
+
+	vector<std::string> server_paths;
+
+	CPPUNIT_ASSERT (get_jack_server_paths (server_dirs, server_names, server_paths));
+
+	cout << "Number of JACK servers on this system: " << server_paths.size () << endl;
+
+	for (vector<std::string>::const_iterator i = server_paths.begin(); i != server_paths.end(); ++i) {
+		cout << "JACK server path: " << *i << endl;
+	}
+
+	vector<std::string> server_paths2;
+
+	CPPUNIT_ASSERT (get_jack_server_paths (server_paths2));
+
+	CPPUNIT_ASSERT (server_paths.size () == server_paths2.size ());
+
+	std::string default_server_path;
+
+	CPPUNIT_ASSERT (get_jack_default_server_path (default_server_path));
+
+	cout << "The default JACK server on this system: " << default_server_path << endl;
+}
+
+void
+JackUtilsTest::test_config ()
+{
+
+}
+
+void
+JackUtilsTest::test_command_line ()
+{
+	cout << endl;
+
+	JackCommandLineOptions options;
+
+	CPPUNIT_ASSERT (get_jack_default_server_path (options.server_path));
+
+	get_jack_default_audio_driver_name (options.driver);
+
+	string command_line;
+
+	// should fail, haven't set any device yet
+	CPPUNIT_ASSERT (!get_jack_command_line_string (options, command_line));
+
+	vector<string> devices = get_jack_device_names_for_audio_driver (options.driver);
+
+	if (!devices.empty()) {
+		options.input_device = devices.front ();
+		options.output_device = devices.front ();
+	} else {
+		cout << "No audio devices available using default JACK driver using Dummy driver" << endl;
+		options.driver = dummy_driver_name;
+		devices = get_jack_device_names_for_audio_driver (options.driver);
+		CPPUNIT_ASSERT (!devices.empty ());
+		options.input_device = devices.front ();
+		options.output_device = devices.front ();
+	}
+
+	options.input_device = devices.front ();
+	options.output_device = devices.front ();
+
+	string midi_driver;
+
+	get_jack_default_midi_system_name (options.driver, options.midi_driver);
+
+	// this at least should create a valid jack command line
+	CPPUNIT_ASSERT (get_jack_command_line_string (options, command_line));
+
+	cout << "Default JACK command line: " << command_line << endl;
+}
+
+void
+JackUtilsTest::test_start_server ()
+{
+#ifdef WIN32
+	cout << endl;
+
+	JackCommandLineOptions options;
+
+	CPPUNIT_ASSERT (get_jack_default_server_path (options.server_path));
+
+	cout << "Starting JACK server at path: " << options.server_path << endl;
+
+	get_jack_default_audio_driver_name (options.driver);
+
+	vector<string> devices = get_jack_device_names_for_audio_driver (options.driver);
+
+	if (!devices.empty()) {
+		options.input_device = devices.front ();
+		options.output_device = devices.front ();
+	} else {
+		cout << "No audio devices available using default JACK driver using Dummy driver" << endl;
+		options.driver = dummy_driver_name;
+		devices = get_jack_device_names_for_audio_driver (options.driver);
+		CPPUNIT_ASSERT (!devices.empty ());
+		options.input_device = devices.front ();
+		options.output_device = devices.front ();
+	}
+
+	string command_line;
+	// this at least should create a valid jack command line
+	CPPUNIT_ASSERT (get_jack_command_line_string (options, command_line));
+
+	cout << "Calling start_jack_server with command line: " << command_line << endl;
+
+	CPPUNIT_ASSERT (start_jack_server (command_line));
+
+	// sleep for 10 seconds
+	Sleep (10*1000);
+
+	CPPUNIT_ASSERT (jack_server_running ());
+#endif
+}
diff --git a/libs/ardour/test/jack_utils_test.h b/libs/ardour/test/jack_utils_test.h
new file mode 100644
index 0000000000..6a42d1d015
--- /dev/null
+++ b/libs/ardour/test/jack_utils_test.h
@@ -0,0 +1,33 @@
+
+#include <cppunit/TestFixture.h>
+#include <cppunit/extensions/HelperMacros.h>
+
+class JackUtilsTest : public CppUnit::TestFixture
+{
+	CPPUNIT_TEST_SUITE (JackUtilsTest);
+	CPPUNIT_TEST (test_driver_names);
+	CPPUNIT_TEST (test_device_names);
+	CPPUNIT_TEST (test_samplerates);
+	CPPUNIT_TEST (test_period_sizes);
+	CPPUNIT_TEST (test_dither_modes);
+	CPPUNIT_TEST (test_connect_server);
+	CPPUNIT_TEST (test_set_jack_path_env);
+	CPPUNIT_TEST (test_server_paths);
+	CPPUNIT_TEST (test_config);
+	CPPUNIT_TEST (test_command_line);
+	CPPUNIT_TEST (test_start_server);
+	CPPUNIT_TEST_SUITE_END ();
+
+public:
+	void test_driver_names ();
+	void test_device_names ();
+	void test_samplerates ();
+	void test_period_sizes ();
+	void test_dither_modes ();
+	void test_connect_server ();
+	void test_set_jack_path_env ();
+	void test_server_paths ();
+	void test_config ();
+	void test_command_line ();
+	void test_start_server ();
+};