Fixed overflow issue. Code originally meant to truncate the 64 bit integer did not...
[ardour.git] / gtk2_ardour / engine_dialog.cc
index 02b7bf67c43fdeb77f28ff0443957d49e949193d..65e3b547a31d1061ebccc983d7f839edf16486ad 100644 (file)
@@ -1,8 +1,10 @@
 #include <vector>
 #include <cmath>
 #include <fstream>
+#include <map>
 
 #include <glibmm.h>
+#include <gtkmm/messagedialog.h>
 #include <pbd/xml++.h>
 
 #ifdef __APPLE__
@@ -22,6 +24,7 @@
 
 #include <pbd/convert.h>
 #include <pbd/error.h>
+#include <pbd/pathscanner.h>
 
 #ifdef __APPLE
 #include <CFBundle.h>
@@ -119,9 +122,6 @@ EngineControl::EngineControl ()
        set_popdown_strings (driver_combo, strings);
        driver_combo.set_active_text (strings.front());
 
-       /* figure out available devices and set up interface_combo */
-
-       enumerate_devices ();
        driver_combo.signal_changed().connect (mem_fun (*this, &EngineControl::driver_changed));
        driver_changed ();
 
@@ -186,6 +186,10 @@ EngineControl::EngineControl ()
        row++;
 #endif
 
+       interface_combo.set_size_request (125, -1);
+       input_device_combo.set_size_request (125, -1);
+       output_device_combo.set_size_request (125, -1);
+
        /*
 
        if (engine_running()) {
@@ -210,6 +214,11 @@ EngineControl::EngineControl ()
 
        options_packer.attach (realtime_button, 1, 2, row, row + 1, FILL|EXPAND, (AttachOptions) 0);
        ++row;
+
+       realtime_button.signal_toggled().connect (mem_fun (*this, &EngineControl::realtime_changed));
+       realtime_changed ();
+
+#ifndef __APPLE__
        label = manage (new Label (_("Realtime Priority")));
        label->set_alignment (1.0, 0.5);
        options_packer.attach (*label, 0, 1, row, row + 1, FILL|EXPAND, (AttachOptions) 0);
@@ -217,10 +226,6 @@ EngineControl::EngineControl ()
        ++row;
        priority_spinner.set_value (60);
 
-       realtime_button.signal_toggled().connect (mem_fun (*this, &EngineControl::realtime_changed));
-       realtime_changed ();
-
-#ifndef __APPLE__
        options_packer.attach (no_memory_lock_button, 1, 2, row, row + 1, FILL|EXPAND, (AttachOptions) 0);
        ++row;
        options_packer.attach (unlock_memory_button, 1, 2, row, row + 1, FILL|EXPAND, (AttachOptions) 0);
@@ -271,19 +276,17 @@ EngineControl::EngineControl ()
        ++row;
 #endif
 
-       strings.clear ();
-
-       find_jack_servers (strings);
+       find_jack_servers (server_strings);
 
-       if (strings.empty()) {
+       if (server_strings.empty()) {
                fatal << _("No JACK server found anywhere on this system. Please install JACK and restart") << endmsg;
                /*NOTREACHED*/
        }
        
-       set_popdown_strings (serverpath_combo, strings);
-       serverpath_combo.set_active_text (strings.front());
+       set_popdown_strings (serverpath_combo, server_strings);
+       serverpath_combo.set_active_text (server_strings.front());
 
-       if (strings.size() > 1) {
+       if (server_strings.size() > 1) {
                label = manage (new Label (_("Server:")));
                options_packer.attach (*label, 0, 1, row, row + 1, FILL|EXPAND, (AttachOptions) 0);
                label->set_alignment (0.0, 0.5);
@@ -360,6 +363,7 @@ EngineControl::build_command_line (vector<string>& cmd)
        bool using_coreaudio = false;
        bool using_netjack = false;
        bool using_ffado = false;
+       bool using_dummy = false;
 
        /* first, path to jackd */
 
@@ -421,7 +425,20 @@ EngineControl::build_command_line (vector<string>& cmd)
                cmd.push_back ("netjack");
        } else if (driver == X_("FFADO")) {
                using_ffado = true;
-               cmd.push_back ("ffado");
+
+               /* do this until FFADO becomes the standard */
+
+               char* hack = getenv ("ARDOUR_FIREWIRE_DRIVER_NAME");
+
+               if (hack) {
+                       cmd.push_back (hack);
+               } else {
+                       cmd.push_back ("freebob");
+               }
+
+       } else if ( driver == X_("Dummy")) {
+               using_dummy = true;
+               cmd.push_back ("dummy");
        }
 
        /* driver arguments */
@@ -435,19 +452,29 @@ EngineControl::build_command_line (vector<string>& cmd)
                        
                } else if (str == _("Playback/Recording on 2 Devices")) {
                        
+                       string input_device = get_device_name (driver, input_device_combo.get_active_text());
+                       string output_device = get_device_name (driver, output_device_combo.get_active_text());
+
+                       if (input_device.empty() || output_device.empty()) {
+                               cmd.clear ();
+                               return;
+                       }
+
                        cmd.push_back ("-C");
-                       cmd.push_back (get_device_name (driver, input_device_combo.get_active_text()));
+                       cmd.push_back (input_device);
                        cmd.push_back ("-P");
-                       cmd.push_back (get_device_name (driver, output_device_combo.get_active_text()));
-                       
+                       cmd.push_back (output_device);
+
                } else if (str == _("Playback only")) {
                        cmd.push_back ("-P");
                } else if (str == _("Recording only")) {
                        cmd.push_back ("-C");
                }
 
-               cmd.push_back ("-n");
-               cmd.push_back (to_string ((uint32_t) floor (periods_spinner.get_value()), std::dec));
+               if (! using_dummy ) {
+                       cmd.push_back ("-n");
+                       cmd.push_back (to_string ((uint32_t) floor (periods_spinner.get_value()), std::dec));
+               }
        }
 
        cmd.push_back ("-r");
@@ -459,8 +486,15 @@ EngineControl::build_command_line (vector<string>& cmd)
        if (using_alsa) {
                
                if (audio_mode_combo.get_active_text() != _("Playback/Recording on 2 Devices")) {
+
+                       string device = get_device_name (driver, interface_combo.get_active_text());
+                       if (device.empty()) {
+                               cmd.clear ();
+                               return;
+                       }
+
                        cmd.push_back ("-d");
-                       cmd.push_back (get_device_name (driver, interface_combo.get_active_text()));
+                       cmd.push_back (device);
                } 
 
                if (hw_meter_button.get_active()) {
@@ -493,8 +527,16 @@ EngineControl::build_command_line (vector<string>& cmd)
        } else if (using_coreaudio) {
 
 #ifdef __APPLE__
-               cmd.push_back ("-n");
-               cmd.push_back (get_device_name (driver, interface_combo.get_active_text()));
+               // note: older versions of the CoreAudio JACK backend use -n instead of -d here
+               
+               string device = get_device_name (driver, interface_combo.get_active_text());
+               if (device.empty()) {
+                       cmd.clear ();
+                       return;
+               }
+
+               cmd.push_back ("-d");
+               cmd.push_back (device);
 #endif
 
        } else if (using_oss) {
@@ -518,13 +560,16 @@ EngineControl::engine_running ()
 }
 
 int
-EngineControl::start_engine ()
+EngineControl::setup_engine ()
 {
        vector<string> args;
        std::string cwd = "/tmp";
-       int ret = 0;
 
        build_command_line (args);
+       
+       if (args.empty()) {
+               return 1; // try again
+       }
 
        Glib::ustring jackdrc_path = Glib::get_home_dir();
        jackdrc_path += "/.jackdrc";
@@ -534,58 +579,52 @@ EngineControl::start_engine ()
                error << string_compose (_("cannot open JACK rc file %1 to store parameters"), jackdrc_path) << endmsg;
                return -1;
        }
-
-       cerr << "will execute ...\n";
+       cerr << "JACK COMMAND: ";
        for (vector<string>::iterator i = args.begin(); i != args.end(); ++i) {
-               jackdrc << (*i) << ' ';
                cerr << (*i) << ' ';
+               jackdrc << (*i) << ' ';
        }
-       jackdrc << endl;
        cerr << endl;
+       jackdrc << endl;
        jackdrc.close ();
 
        _used = true;
-       
-#if 0
-
-       try {
-               spawn_async_with_pipes (cwd, args, SpawnFlags (0), sigc::slot<void>(), &engine_pid, &engine_stdin, &engine_stdout, &engine_stderr);
-       }
-       
-       catch (Glib::Exception& err) {
-               error << _("could not start JACK server: ") << err.what() << endmsg;
-               ret = -1;
-       }
-#endif
-
-       return ret;
-}
 
-int
-EngineControl::stop_engine ()
-{
        return 0;
 }
 
 void
 EngineControl::realtime_changed ()
 {
+#ifndef __APPLE__
        priority_spinner.set_sensitive (realtime_button.get_active());
+#endif
 }
 
 void
-EngineControl::enumerate_devices ()
+EngineControl::enumerate_devices (const string& driver)
 {
        /* note: case matters for the map keys */
 
-#ifdef __APPLE__
-       devices["CoreAudio"] = enumerate_coreaudio_devices ();
+       if (driver == "CoreAudio") {
+#ifdef __APPLE__               
+               devices[driver] = enumerate_coreaudio_devices ();
+#endif
+
+#ifndef __APPLE__
+       } else if (driver == "ALSA") {
+               devices[driver] = enumerate_alsa_devices ();
+       } else if (driver == "FFADO") {
+               devices[driver] = enumerate_ffado_devices ();
+       } else if (driver == "OSS") {
+               devices[driver] = enumerate_oss_devices ();
+       } else if (driver == "Dummy") {
+               devices[driver] = enumerate_dummy_devices ();
+       } else if (driver == "NetJACK") {
+               devices[driver] = enumerate_netjack_devices ();
+       }
 #else
-       devices["ALSA"] = enumerate_alsa_devices ();
-       devices["FFADO"] = enumerate_ffado_devices ();
-       devices["OSS"] = enumerate_oss_devices ();
-       devices["Dummy"] = enumerate_dummy_devices ();
-       devices["NetJACK"] = enumerate_netjack_devices ();
+        }
 #endif
 }
 
@@ -628,8 +667,30 @@ EngineControl::enumerate_coreaudio_devices ()
                if (err == noErr) {
                        // Look for the CoreAudio device name...
                        char coreDeviceName[256];
-                       size_t nameSize = sizeof (coreDeviceName);
+                       size_t nameSize;
+
                        for (int i = 0; i < numCoreDevices; i++) {
+
+                               nameSize = sizeof (coreDeviceName);
+
+                               /* enforce duplex devices only */
+
+                               err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
+                                                                0, true, kAudioDevicePropertyStreams,
+                                                                &outSize, &isWritable);
+
+                               if (err != noErr || outSize == 0) {
+                                       continue;
+                               }
+
+                               err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
+                                                                0, false, kAudioDevicePropertyStreams,
+                                                                &outSize, &isWritable);
+
+                               if (err != noErr || outSize == 0) {
+                                       continue;
+                               }
+
                                err = AudioDeviceGetPropertyInfo(coreDeviceIDs[i],
                                                                 0, true, kAudioDevicePropertyDeviceName,
                                                                 &outSize, &isWritable);
@@ -638,7 +699,6 @@ EngineControl::enumerate_coreaudio_devices ()
                                                                     0, true, kAudioDevicePropertyDeviceName,
                                                                     &nameSize, (void *) coreDeviceName);
                                        if (err == noErr) {
-
                                                char drivername[128];
 
                                                // this returns the unique id for the device
@@ -655,6 +715,28 @@ EngineControl::enumerate_coreaudio_devices ()
                delete [] coreDeviceIDs;
        }
 
+
+       if (devs.size() == 0) {
+               MessageDialog msg (_("\
+You do not have any audio devices capable of\n\
+simultaneous playback and recording.\n\n\
+Please use Applications -> Utilities -> Audio MIDI Setup\n\
+to create an \"aggregrate\" device, or install a suitable\n\
+audio interface.\n\n\
+Please send email to Apple and ask them why new Macs\n\
+have no duplex audio device.\n\n\
+Alternatively, if you really want just playback\n\
+or recording but not both, start JACK before running\n\
+Ardour and choose the relevant device then."
+                                          ), 
+                                  true, Gtk::MESSAGE_ERROR, Gtk::BUTTONS_OK);
+               msg.set_title (_("No suitable audio devices"));
+               msg.set_position (Gtk::WIN_POS_MOUSE);
+               msg.run ();
+               exit (1);
+       }
+
+
        return devs;
 }
 #else
@@ -723,8 +805,10 @@ vector<string>
 EngineControl::enumerate_ffado_devices ()
 {
        vector<string> devs;
+       backend_devs.clear ();
        return devs;
 }
+
 vector<string>
 EngineControl::enumerate_oss_devices ()
 {
@@ -749,11 +833,19 @@ void
 EngineControl::driver_changed ()
 {
        string driver = driver_combo.get_active_text();
-       vector<string>& strings = devices[driver];
        string::size_type maxlen = 0;
        int maxindex = -1;
        int n = 0;
 
+       enumerate_devices (driver);
+
+       vector<string>& strings = devices[driver];
+
+       if (strings.empty() && driver != "FFADO" && driver != "Dummy") {
+               error << string_compose (_("No devices found for driver \"%1\""), driver) << endmsg;
+               return;
+       }
+       
        for (vector<string>::iterator i = strings.begin(); i != strings.end(); ++i, ++n) {
                if ((*i).length() > maxlen) {
                        maxlen = (*i).length();
@@ -765,16 +857,11 @@ EngineControl::driver_changed ()
        set_popdown_strings (input_device_combo, strings);
        set_popdown_strings (output_device_combo, strings);
 
-       const guint32 FUDGE = 18; // Combo's are stupid - they steal space from the entry for the button interface_combo
-       set_size_request_to_display_given_text (interface_combo, strings[maxindex].c_str(), 5+FUDGE, 5);
-       set_size_request_to_display_given_text (input_device_combo, strings[maxindex].c_str(), 5+FUDGE, 5);
-       set_size_request_to_display_given_text (output_device_combo, strings[maxindex].c_str(), 5+FUDGE, 5);
-
        if (!strings.empty()) {
                interface_combo.set_active_text (strings.front());
                input_device_combo.set_active_text (strings.front());
                output_device_combo.set_active_text (strings.front());
-       }
+       } 
        
        if (driver == "ALSA") {
                soft_mode_button.set_sensitive (true);
@@ -832,6 +919,11 @@ EngineControl::audio_mode_changed ()
        }
 }
 
+static bool jack_server_filter(const string& str, void *arg)
+{
+   return str == "jackd" || str == "jackdmp";
+}
+
 void
 EngineControl::find_jack_servers (vector<string>& strings)
 {
@@ -845,46 +937,70 @@ EngineControl::find_jack_servers (vector<string>& strings)
 
        _NSGetExecutablePath (execpath, &pathsz);
        
-       cerr << " execpath = " << execpath << endl;
-
-       Glib::ustring path (Glib::path_get_dirname (execpath));
+       string path (Glib::path_get_dirname (execpath));
        path += "/jackd";
 
        if (Glib::file_test (path, FILE_TEST_EXISTS)) {
                strings.push_back (path);
-               cerr << "Found jack in " << path << endl;
        } 
 
-       if (ARDOUR::Profile->get_single_package()) {
+       if (getenv ("ARDOUR_WITH_JACK")) {
                /* no other options - only use the JACK we supply */
                if (strings.empty()) {
-                       // cerr << "OOPS!\n";
-                       // fatal << _("JACK appears to be missing from the Ardour bundle") << endmsg;
+                       fatal << _("JACK appears to be missing from the Ardour bundle") << endmsg;
                        /*NOTREACHED*/
                }
                return;
        }
+#else
+       string path;
 #endif
        
-       if (Glib::file_test ("/usr/bin/jackd", FILE_TEST_EXISTS)) {
-               strings.push_back ("/usr/bin/jackd");
-       }
-       if (Glib::file_test ("/usr/local/bin/jackd", FILE_TEST_EXISTS)) {
-               strings.push_back ("/usr/local/bin/jackd");
-       }
-       if (Glib::file_test ("/opt/bin/jackd", FILE_TEST_EXISTS)) {
-               strings.push_back ("/opt/bin/jackd");
-       }
-       if (Glib::file_test ("/usr/bin/jackdmp", FILE_TEST_EXISTS)) {
-               strings.push_back ("/usr/bin/jackd");
-       }
-       if (Glib::file_test ("/usr/local/bin/jackdmp", FILE_TEST_EXISTS)) {
-               strings.push_back ("/usr/local/bin/jackd");
+       PathScanner scanner;
+       vector<string *> *jack_servers;
+       std::map<string,int> un;
+       char *p;
+       bool need_minimal_path = false;
+
+       p = getenv ("PATH");
+
+       if (p && *p) {
+               path = p;
+       } else {
+               need_minimal_path = true;
        }
-       if (Glib::file_test ("/opt/bin/jackdmp", FILE_TEST_EXISTS)) {
-               strings.push_back ("/opt/bin/jackd");
+
+#ifdef __APPLE__
+       // many mac users don't have PATH set up to include
+       // likely installed locations of JACK
+       need_minimal_path = true;
+#endif
+
+       if (need_minimal_path) {
+               if (path.empty()) {
+                       path = "/usr/bin:/bin:/usr/local/bin:/opt/local/bin";
+               } else {
+                       path += ":/usr/local/bin:/opt/local/bin";
+               }
        }
 
+#ifdef __APPLE__
+       // push it back into the environment so that auto-started JACK can find it.
+       // XXX why can't we just expect OS X users to have PATH set correctly? we can't ...
+       setenv ("PATH", path.c_str(), 1);
+#endif
+
+       jack_servers = scanner (path, jack_server_filter, 0, false, true);
+       
+       vector<string *>::iterator iter;
+       
+       for (iter = jack_servers->begin(); iter != jack_servers->end(); iter++) {
+               string p = **iter;
+               
+               if (un[p]++ == 0) {
+                       strings.push_back(p);
+               }
+       }
 }
 
 string
@@ -893,6 +1009,15 @@ EngineControl::get_device_name (const string& driver, const string& human_readab
        vector<string>::iterator n;
        vector<string>::iterator i;
 
+       if (human_readable.empty()) {
+               /* this can happen if the user's .ardourrc file has a device name from
+                  another computer system in it
+               */
+               MessageDialog msg (_("You need to choose an audio device first."));
+               msg.run ();
+               return string();
+       }
+
        if (backend_devs.empty()) {
                return human_readable;
        }
@@ -904,12 +1029,9 @@ EngineControl::get_device_name (const string& driver, const string& human_readab
        }
        
        if (i == devices[driver].end()) {
-               fatal << string_compose (_("programming error: %1"), "true hardware name for ID missing") << endmsg;
-               /*NOTREACHED*/
+               warning << string_compose (_("Audio device \"%1\" not known on this computer."), human_readable) << endmsg;
        }
 
-       /* keep gcc happy */
-
        return string();
 }
 
@@ -1030,19 +1152,31 @@ EngineControl::set_state (const XMLNode& root)
        XMLNodeConstIterator citer;
        XMLNode* child;
        XMLProperty* prop;
-
+       bool using_dummy = false;
+       
        int val;
        string strval;
-
+       
+       if ( (child = root.child ("driver"))){
+               prop = child->property("val");
+               if (prop && (prop->value() == "Dummy") ) {
+                       using_dummy = true;
+               }
+       }
+       
        clist = root.children();
 
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
-
+               if ( prop && (prop->value() == "FFADO" ))
+                               continue;
                child = *citer;
 
                prop = child->property ("val");
 
                if (!prop || prop->value().empty()) {
+
+                       if ( using_dummy && ( child->name() == "interface" || child->name() == "inputdevice" || child->name() == "outputdevice" ))
+                               continue;
                        error << string_compose (_("AudioSetup value for %1 is missing data"), child->name()) << endmsg;
                        continue;
                }
@@ -1109,7 +1243,24 @@ EngineControl::set_state (const XMLNode& root)
                } else if (child->name() == "periodsize") {
                        period_size_combo.set_active_text(strval);
                } else if (child->name() == "serverpath") {
-                       serverpath_combo.set_active_text(strval);
+                       /* do not allow us to use a server path that doesn't
+                          exist on this system. this handles cases where
+                          the user has an RC file listing a serverpath
+                          from some other machine.
+                       */
+                       vector<string>::iterator x;
+                       for (x = server_strings.begin(); x != server_strings.end(); ++x) {
+                               if (*x == strval) {
+                                       break;
+                               }
+                       }
+                       if (x != server_strings.end()) {
+                               serverpath_combo.set_active_text (strval);
+                       } else {
+                               warning << string_compose (_("configuration files contain a JACK server path that doesn't exist (%1)"),
+                                                            strval)
+                                       << endmsg;
+                       }
                } else if (child->name() == "driver") {
                        driver_combo.set_active_text(strval);
                } else if (child->name() == "interface") {