2 Copyright (C) 2010 Paul Davis
3 Copyright (C) 2011 Tim Mayberry
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <alsa/asoundlib.h>
26 #include <CoreAudio/CoreAudio.h>
27 #include <CoreFoundation/CFString.h>
28 #include <sys/param.h>
29 #include <mach-o/dyld.h>
33 #include <portaudio.h>
36 #include <jack/jack.h>
40 #include <boost/scoped_ptr.hpp>
42 #include <glibmm/miscutils.h>
45 #include "pbd/error.h"
46 #include "pbd/convert.h"
47 #include "pbd/file_utils.h"
48 #include "pbd/search_path.h"
50 #include "jack_utils.h"
62 // The pretty driver names
63 const char * const portaudio_driver_name = X_("Portaudio");
64 const char * const coreaudio_driver_name = X_("CoreAudio");
65 const char * const alsa_driver_name = X_("ALSA");
66 const char * const oss_driver_name = X_("OSS");
67 const char * const freebob_driver_name = X_("FreeBoB");
68 const char * const ffado_driver_name = X_("FFADO");
69 const char * const netjack_driver_name = X_("NetJACK");
70 const char * const dummy_driver_name = X_("Dummy");
75 // The real driver names
76 const char * const portaudio_driver_command_line_name = X_("portaudio");
77 const char * const coreaudio_driver_command_line_name = X_("coreaudio");
78 const char * const alsa_driver_command_line_name = X_("alsa");
79 const char * const oss_driver_command_line_name = X_("oss");
80 const char * const freebob_driver_command_line_name = X_("freebob");
81 const char * const ffado_driver_command_line_name = X_("firewire");
82 const char * const netjack_driver_command_line_name = X_("netjack");
83 const char * const dummy_driver_command_line_name = X_("dummy");
85 // should we provide more "pretty" names like above?
86 const char * const alsaint_midi_driver_name = X_("alsa");
87 const char * const alsaseq_midi_driver_name = X_("seq");
88 const char * const alsaraw_midi_driver_name = X_("raw");
89 const char * const winmme_midi_driver_name = X_("winmme");
90 const char * const coremidi_midi_driver_name = X_("coremidi");
92 // this should probably be translated
93 const char * const default_device_name = X_("Default");
96 static ARDOUR::MidiOptions midi_options;
105 ARDOUR::get_jack_audio_driver_names (vector<string>& audio_driver_names)
108 audio_driver_names.push_back (portaudio_driver_name);
110 audio_driver_names.push_back (coreaudio_driver_name);
113 audio_driver_names.push_back (alsa_driver_name);
115 audio_driver_names.push_back (oss_driver_name);
116 audio_driver_names.push_back (freebob_driver_name);
117 audio_driver_names.push_back (ffado_driver_name);
119 audio_driver_names.push_back (netjack_driver_name);
120 audio_driver_names.push_back (dummy_driver_name);
124 ARDOUR::get_jack_default_audio_driver_name (string& audio_driver_name)
126 vector<string> drivers;
127 get_jack_audio_driver_names (drivers);
128 audio_driver_name = drivers.front ();
132 ARDOUR::get_jack_sample_rate_strings (vector<string>& samplerates)
134 // do these really need to be translated?
135 samplerates.push_back (_("8000Hz"));
136 samplerates.push_back (_("22050Hz"));
137 samplerates.push_back (_("44100Hz"));
138 samplerates.push_back (_("48000Hz"));
139 samplerates.push_back (_("88200Hz"));
140 samplerates.push_back (_("96000Hz"));
141 samplerates.push_back (_("192000Hz"));
145 ARDOUR::get_jack_default_sample_rate ()
151 ARDOUR::get_jack_period_size_strings (std::vector<std::string>& period_sizes)
153 period_sizes.push_back ("32");
154 period_sizes.push_back ("64");
155 period_sizes.push_back ("128");
156 period_sizes.push_back ("256");
157 period_sizes.push_back ("512");
158 period_sizes.push_back ("1024");
159 period_sizes.push_back ("2048");
160 period_sizes.push_back ("4096");
161 period_sizes.push_back ("8192");
165 ARDOUR::get_jack_default_period_size ()
171 ARDOUR::get_jack_dither_mode_strings (const string& driver, vector<string>& dither_modes)
173 dither_modes.push_back (get_none_string ());
175 if (driver == alsa_driver_name ) {
176 dither_modes.push_back (_("Triangular"));
177 dither_modes.push_back (_("Rectangular"));
178 dither_modes.push_back (_("Shaped"));
183 ARDOUR::get_jack_default_dither_mode (const string& /*driver*/)
185 return get_none_string ();
189 ARDOUR::get_jack_latency_string (string samplerate, float periods, string period_size)
191 uint32_t rate = atoi (samplerate);
192 float psize = atof (period_size);
195 snprintf (buf, sizeof(buf), "%.1fmsec", (periods * psize) / (rate/1000.0));
201 get_jack_command_line_audio_driver_name (const string& driver_name, string& command_line_name)
203 using namespace ARDOUR;
204 if (driver_name == portaudio_driver_name) {
205 command_line_name = portaudio_driver_command_line_name;
207 } else if (driver_name == coreaudio_driver_name) {
208 command_line_name = coreaudio_driver_command_line_name;
210 } else if (driver_name == alsa_driver_name) {
211 command_line_name = alsa_driver_command_line_name;
213 } else if (driver_name == oss_driver_name) {
214 command_line_name = oss_driver_command_line_name;
216 } else if (driver_name == freebob_driver_name) {
217 command_line_name = freebob_driver_command_line_name;
219 } else if (driver_name == ffado_driver_name) {
220 command_line_name = ffado_driver_command_line_name;
222 } else if (driver_name == netjack_driver_name) {
223 command_line_name = netjack_driver_command_line_name;
225 } else if (driver_name == dummy_driver_name) {
226 command_line_name = dummy_driver_command_line_name;
233 get_jack_command_line_audio_device_name (const string& driver_name,
234 const string& device_name, string& command_line_device_name)
236 using namespace ARDOUR;
237 device_map_t devices;
239 get_jack_device_names_for_audio_driver (driver_name, devices);
241 for (device_map_t::const_iterator i = devices.begin (); i != devices.end(); ++i) {
242 if (i->first == device_name) {
243 command_line_device_name = i->second;
251 get_jack_command_line_dither_mode (const string& dither_mode, string& command_line_dither_mode)
253 using namespace ARDOUR;
255 if (dither_mode == _("Triangular")) {
256 command_line_dither_mode = "triangular";
258 } else if (dither_mode == _("Rectangular")) {
259 command_line_dither_mode = "rectangular";
261 } else if (dither_mode == _("Shaped")) {
262 command_line_dither_mode = "shaped";
270 ARDOUR::get_jack_alsa_device_names (device_map_t& devices)
274 snd_ctl_card_info_t *info;
275 snd_pcm_info_t *pcminfo;
276 snd_ctl_card_info_alloca(&info);
277 snd_pcm_info_alloca(&pcminfo);
282 while (snd_card_next (&cardnum) >= 0 && cardnum >= 0) {
285 devname += PBD::to_string (cardnum, std::dec);
287 if (snd_ctl_open (&handle, devname.c_str(), 0) >= 0 && snd_ctl_card_info (handle, info) >= 0) {
289 if (snd_ctl_card_info (handle, info) < 0) {
293 string card_name = snd_ctl_card_info_get_name (info);
295 /* change devname to use ID, not number */
298 devname += snd_ctl_card_info_get_id (info);
300 while (snd_ctl_pcm_next_device (handle, &device) >= 0 && device >= 0) {
302 /* only detect duplex devices here. more
303 * complex arrangements are beyond our scope
306 snd_pcm_info_set_device (pcminfo, device);
307 snd_pcm_info_set_subdevice (pcminfo, 0);
308 snd_pcm_info_set_stream (pcminfo, SND_PCM_STREAM_CAPTURE);
310 if (snd_ctl_pcm_info (handle, pcminfo) >= 0) {
312 snd_pcm_info_set_device (pcminfo, device);
313 snd_pcm_info_set_subdevice (pcminfo, 0);
314 snd_pcm_info_set_stream (pcminfo, SND_PCM_STREAM_PLAYBACK);
316 if (snd_ctl_pcm_info (handle, pcminfo) >= 0) {
318 devname += PBD::to_string (device, std::dec);
319 devices.insert (std::make_pair (card_name, devname));
324 snd_ctl_close(handle);
328 /* silence a compiler unused variable warning */
335 getDeviceUIDFromID( AudioDeviceID id, char *name, size_t nsize)
337 UInt32 size = sizeof(CFStringRef);
339 OSStatus res = AudioDeviceGetProperty(id, 0, false,
340 kAudioDevicePropertyDeviceUID, &size, &UI);
342 CFStringGetCString(UI,name,nsize,CFStringGetSystemEncoding());
349 ARDOUR::get_jack_coreaudio_device_names (device_map_t& devices)
352 // Find out how many Core Audio devices are there, if any...
353 // (code snippet gently "borrowed" from St?hane Letz jackdmp;)
356 UInt32 outSize = sizeof(isWritable);
358 err = AudioHardwareGetPropertyInfo(kAudioHardwarePropertyDevices,
359 &outSize, &isWritable);
361 // Calculate the number of device available...
362 int numCoreDevices = outSize / sizeof(AudioDeviceID);
363 // Make space for the devices we are about to get...
364 AudioDeviceID *coreDeviceIDs = new AudioDeviceID [numCoreDevices];
365 err = AudioHardwareGetProperty(kAudioHardwarePropertyDevices,
366 &outSize, (void *) coreDeviceIDs);
368 // Look for the CoreAudio device name...
369 char coreDeviceName[256];
372 for (int i = 0; i < numCoreDevices; i++) {
374 nameSize = sizeof (coreDeviceName);
376 /* enforce duplex devices only */
378 err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
379 0, true, kAudioDevicePropertyStreams,
380 &outSize, &isWritable);
382 if (err != noErr || outSize == 0) {
386 err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
387 0, false, kAudioDevicePropertyStreams,
388 &outSize, &isWritable);
390 if (err != noErr || outSize == 0) {
394 err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
395 0, true, kAudioDevicePropertyDeviceName,
396 &outSize, &isWritable);
398 err = AudioDeviceGetProperty(coreDeviceIDs[i],
399 0, true, kAudioDevicePropertyDeviceName,
400 &nameSize, (void *) coreDeviceName);
402 char drivername[128];
404 // this returns the unique id for the device
405 // that must be used on the commandline for jack
407 if (getDeviceUIDFromID(coreDeviceIDs[i], drivername, sizeof (drivername)) == noErr) {
408 devices.insert (make_pair (coreDeviceName, drivername));
414 delete [] coreDeviceIDs;
417 /* silence a compiler unused variable warning */
423 ARDOUR::get_jack_portaudio_device_names (device_map_t& devices)
425 #ifdef HAVE_PORTAUDIO
426 if (Pa_Initialize() != paNoError) {
430 for (PaDeviceIndex i = 0; i < Pa_GetDeviceCount (); ++i) {
432 string readable_name;
433 string jack_device_name;
434 const PaDeviceInfo* device_info = Pa_GetDeviceInfo(i);
436 if (device_info != NULL) { // it should never be ?
437 api_name = Pa_GetHostApiInfo (device_info->hostApi)->name;
438 readable_name = api_name + " " + device_info->name;
439 jack_device_name = api_name + "::" + device_info->name;
440 devices.insert (make_pair (readable_name, jack_device_name));
445 /* silence a compiler unused variable warning */
451 ARDOUR::get_jack_oss_device_names (device_map_t& devices)
453 devices.insert (make_pair (default_device_name, default_device_name));
457 ARDOUR::get_jack_freebob_device_names (device_map_t& devices)
459 devices.insert (make_pair (default_device_name, default_device_name));
463 ARDOUR::get_jack_ffado_device_names (device_map_t& devices)
465 devices.insert (make_pair (default_device_name, default_device_name));
469 ARDOUR::get_jack_netjack_device_names (device_map_t& devices)
471 devices.insert (make_pair (default_device_name, default_device_name));
475 ARDOUR::get_jack_dummy_device_names (device_map_t& devices)
477 devices.insert (make_pair (default_device_name, default_device_name));
481 ARDOUR::get_jack_device_names_for_audio_driver (const string& driver_name, device_map_t& devices)
485 if (driver_name == portaudio_driver_name) {
486 get_jack_portaudio_device_names (devices);
487 } else if (driver_name == coreaudio_driver_name) {
488 get_jack_coreaudio_device_names (devices);
489 } else if (driver_name == alsa_driver_name) {
490 get_jack_alsa_device_names (devices);
491 } else if (driver_name == oss_driver_name) {
492 get_jack_oss_device_names (devices);
493 } else if (driver_name == freebob_driver_name) {
494 get_jack_freebob_device_names (devices);
495 } else if (driver_name == ffado_driver_name) {
496 get_jack_ffado_device_names (devices);
497 } else if (driver_name == netjack_driver_name) {
498 get_jack_netjack_device_names (devices);
499 } else if (driver_name == dummy_driver_name) {
500 get_jack_dummy_device_names (devices);
503 return !devices.empty();
507 std::vector<std::string>
508 ARDOUR::get_jack_device_names_for_audio_driver (const string& driver_name)
510 std::vector<std::string> readable_names;
511 device_map_t devices;
513 get_jack_device_names_for_audio_driver (driver_name, devices);
515 for (device_map_t::const_iterator i = devices.begin (); i != devices.end(); ++i) {
516 readable_names.push_back (i->first);
519 return readable_names;
523 ARDOUR::get_jack_audio_driver_supports_two_devices (const string& driver)
525 return (driver == alsa_driver_name || driver == oss_driver_name);
529 ARDOUR::get_jack_audio_driver_supports_latency_adjustment (const string& driver)
531 return (driver == alsa_driver_name || driver == coreaudio_driver_name ||
532 driver == ffado_driver_name || driver == portaudio_driver_name);
536 ARDOUR::get_jack_audio_driver_supports_setting_period_count (const string& driver)
538 return !(driver == dummy_driver_name || driver == coreaudio_driver_name ||
539 driver == portaudio_driver_name);
543 ARDOUR::get_jack_server_application_names (std::vector<std::string>& server_names)
546 server_names.push_back ("jackd.exe");
548 server_names.push_back ("jackd");
549 server_names.push_back ("jackdmp");
551 return !server_names.empty();
555 ARDOUR::set_path_env_for_jack_autostart (const vector<std::string>& dirs)
558 // push it back into the environment so that auto-started JACK can find it.
559 // XXX why can't we just expect OS X users to have PATH set correctly? we can't ...
560 setenv ("PATH", Searchpath(dirs).to_string().c_str(), 1);
562 /* silence a compiler unused variable warning */
568 ARDOUR::get_jack_server_dir_paths (vector<std::string>& server_dir_paths)
571 /* this magic lets us finds the path to the OSX bundle, and then
572 we infer JACK's location from there
575 char execpath[MAXPATHLEN+1];
576 uint32_t pathsz = sizeof (execpath);
578 _NSGetExecutablePath (execpath, &pathsz);
580 server_dir_paths.push_back (Glib::path_get_dirname (execpath));
583 Searchpath sp(string(g_getenv("PATH")));
586 gchar *install_dir = g_win32_get_package_installation_directory_of_module (NULL);
588 sp.push_back (install_dir);
589 g_free (install_dir);
591 // don't try and use a system wide JACK install yet.
594 sp.push_back ("/usr/bin");
595 sp.push_back ("/bin");
596 sp.push_back ("/usr/local/bin");
597 sp.push_back ("/opt/local/bin");
601 std::copy (sp.begin(), sp.end(), std::back_inserter(server_dir_paths));
603 return !server_dir_paths.empty();
607 ARDOUR::get_jack_server_paths (const vector<std::string>& server_dir_paths,
608 const vector<string>& server_names,
609 vector<std::string>& server_paths)
611 for (vector<string>::const_iterator i = server_names.begin(); i != server_names.end(); ++i) {
612 Glib::PatternSpec ps (*i);
613 find_matching_files_in_directories (server_dir_paths, ps, server_paths);
615 return !server_paths.empty();
619 ARDOUR::get_jack_server_paths (vector<std::string>& server_paths)
621 vector<std::string> server_dirs;
623 if (!get_jack_server_dir_paths (server_dirs)) {
627 vector<string> server_names;
629 if (!get_jack_server_application_names (server_names)) {
633 if (!get_jack_server_paths (server_dirs, server_names, server_paths)) {
637 return !server_paths.empty();
641 ARDOUR::get_jack_default_server_path (std::string& server_path)
643 vector<std::string> server_paths;
645 if (!get_jack_server_paths (server_paths)) {
649 server_path = server_paths.front ();
654 quote_string (const string& str)
656 return "\"" + str + "\"";
659 ARDOUR::JackCommandLineOptions::JackCommandLineOptions ()
666 , unlock_gui_libs(false)
677 , hardware_metering(false)
678 , hardware_monitoring(false)
688 ARDOUR::get_jack_command_line_string (JackCommandLineOptions& options, string& command_line, bool for_latency_measurement)
692 args.push_back (options.server_path);
695 // must use sync mode on windows
696 args.push_back ("-S");
698 // this needs to be added now on windows
699 if (!options.midi_driver.empty () && options.midi_driver != get_none_string ()) {
700 args.push_back ("-X");
701 args.push_back (options.midi_driver);
705 /* XXX hack to enforce qjackctl-like behaviour */
706 if (options.timeout == 0) {
707 options.timeout = 200;
710 if (options.timeout) {
711 args.push_back ("-t");
712 args.push_back (to_string (options.timeout, std::dec));
715 if (options.no_mlock) {
716 args.push_back ("-m");
719 args.push_back ("-p");
720 args.push_back (to_string(options.ports_max, std::dec));
722 if (options.realtime) {
723 args.push_back ("-R");
724 if (options.priority != 0) {
725 args.push_back ("-P");
726 args.push_back (to_string(options.priority, std::dec));
729 args.push_back ("-r");
732 if (options.unlock_gui_libs) {
733 args.push_back ("-u");
736 if (options.verbose) {
737 args.push_back ("-v");
741 if (options.temporary) {
742 args.push_back ("-T");
746 if (options.driver == alsa_driver_name) {
747 if (options.midi_driver == alsaint_midi_driver_name) {
748 args.push_back ("-I");
749 args.push_back ("alsa_midi");
753 string command_line_driver_name;
755 if (!get_jack_command_line_audio_driver_name (options.driver, command_line_driver_name)) {
759 args.push_back ("-d");
760 args.push_back (command_line_driver_name);
762 if (options.output_device.empty() && options.input_device.empty()) {
766 string command_line_input_device_name;
767 string command_line_output_device_name;
769 if (!get_jack_command_line_audio_device_name (options.driver,
770 options.input_device, command_line_input_device_name)) {
774 if (!get_jack_command_line_audio_device_name (options.driver,
775 options.output_device, command_line_output_device_name)) {
779 if (options.input_device.empty()) {
781 if (options.output_device.empty()) {
784 args.push_back ("-P");
785 } else if (options.output_device.empty()) {
787 if (options.input_device.empty()) {
790 args.push_back ("-C");
791 } else if (options.input_device != options.output_device) {
792 // capture and playback on two devices if supported
793 if (get_jack_audio_driver_supports_two_devices (options.driver)) {
794 args.push_back ("-C");
795 args.push_back (command_line_input_device_name);
796 args.push_back ("-P");
797 args.push_back (command_line_output_device_name);
803 if (options.input_channels) {
804 args.push_back ("-i");
805 args.push_back (to_string (options.input_channels, std::dec));
808 if (options.output_channels) {
809 args.push_back ("-o");
810 args.push_back (to_string (options.output_channels, std::dec));
813 if (get_jack_audio_driver_supports_setting_period_count (options.driver)) {
814 args.push_back ("-n");
815 args.push_back (to_string (options.num_periods, std::dec));
818 args.push_back ("-r");
819 args.push_back (to_string (options.samplerate, std::dec));
821 args.push_back ("-p");
822 args.push_back (to_string (options.period_size, std::dec));
824 if (!for_latency_measurement && get_jack_audio_driver_supports_latency_adjustment (options.driver)) {
825 if (options.input_latency) {
826 args.push_back ("-I");
827 args.push_back (to_string (options.input_latency, std::dec));
829 if (options.output_latency) {
830 args.push_back ("-O");
831 args.push_back (to_string (options.output_latency, std::dec));
835 if (options.input_device == options.output_device && options.input_device != default_device_name) {
836 args.push_back ("-d");
837 args.push_back (command_line_input_device_name);
840 if (options.driver == alsa_driver_name) {
841 if (options.hardware_metering) {
842 args.push_back ("-M");
844 if (options.hardware_monitoring) {
845 args.push_back ("-H");
848 string command_line_dither_mode;
849 if (get_jack_command_line_dither_mode (options.dither_mode, command_line_dither_mode)) {
850 args.push_back ("-z");
851 args.push_back (command_line_dither_mode);
853 if (options.force16_bit) {
854 args.push_back ("-S");
856 if (options.soft_mode) {
857 args.push_back ("-s");
861 if (options.driver == alsa_driver_name || options.driver == coreaudio_driver_name) {
863 if (options.midi_driver != alsaint_midi_driver_name) {
864 if (!options.midi_driver.empty() && options.midi_driver != get_none_string ()) {
865 args.push_back ("-X");
866 args.push_back (options.midi_driver);
873 for (vector<string>::const_iterator i = args.begin(); i != args.end();) {
875 oss << quote_string (*i);
879 if (++i != args.end()) oss << ' ';
882 command_line = oss.str();
887 ARDOUR::get_jack_server_config_file_name ()
893 ARDOUR::get_jack_server_user_config_dir_path ()
895 return Glib::get_home_dir ();
899 ARDOUR::get_jack_server_user_config_file_path ()
901 return Glib::build_filename (get_jack_server_user_config_dir_path (), get_jack_server_config_file_name ());
905 ARDOUR::write_jack_config_file (const std::string& config_file_path, const string& command_line)
907 ofstream jackdrc (config_file_path.c_str());
910 error << string_compose (_("cannot open JACK rc file %1 to store parameters"), config_file_path) << endmsg;
914 jackdrc << command_line << endl;
920 ARDOUR::enumerate_midi_options ()
922 if (midi_options.empty()) {
924 midi_options.push_back (make_pair (_("ALSA"), alsaint_midi_driver_name));
925 midi_options.push_back (make_pair (_("(legacy) ALSA raw devices"), alsaraw_midi_driver_name));
926 midi_options.push_back (make_pair (_("(legacy) ALSA sequencer"), alsaseq_midi_driver_name));
928 #ifdef HAVE_PORTAUDIO
929 /* Windows folks: what name makes sense here? Are there other
932 midi_options.push_back (make_pair (_("Multimedia Extension"), winmme_midi_driver_name));
935 midi_options.push_back (make_pair (_("CoreMIDI"), coremidi_midi_driver_name));
941 v.push_back (get_none_string());
943 for (MidiOptions::const_iterator i = midi_options.begin(); i != midi_options.end(); ++i) {
944 v.push_back (i->first);
951 ARDOUR::set_midi_option (ARDOUR::JackCommandLineOptions& options, const string& opt)
953 if (opt.empty() || opt == get_none_string()) {
954 options.midi_driver = "";
958 for (MidiOptions::const_iterator i = midi_options.begin(); i != midi_options.end(); ++i) {
959 if (i->first == opt) {
960 options.midi_driver = i->second;