vestige-based VST support, back-ported from 2.0-ongoing
[ardour.git] / gtk2_ardour / main.cc
index e9ac25a8f81b0f28e8f781dc6eff69473a43e67e..32454d69d561c655582b17e3c37fb89b2b4a0616 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2001-2006 Paul Davis
+    Copyright (C) 2001-2007 Paul Davis
     
     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
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
-#include <sys/types.h>
-#include <sys/mman.h>
-#include <sys/wait.h>
-#include <cerrno>
 #include <cstdlib>
 #include <signal.h>
-#include <unistd.h>
 
 #include <sigc++/bind.h>
 #include <gtkmm/settings.h>
 
-#include <pbd/error.h>
-#include <pbd/textreceiver.h>
-#include <pbd/failed_constructor.h>
-#include <pbd/pthread_utils.h>
+#include "pbd/error.h"
+#include "pbd/file_utils.h"
+#include "pbd/textreceiver.h"
+#include "pbd/failed_constructor.h"
+#include "pbd/pthread_utils.h"
 
 #include <jack/jack.h>
 
-#include <ardour/version.h>
-#include <ardour/ardour.h>
-#include <ardour/audioengine.h>
+#include "ardour/svn_revision.h"
+#include "ardour/version.h"
+#include "ardour/ardour.h"
+#include "ardour/audioengine.h"
+#include "ardour/session_utils.h"
+#include "ardour/filesystem_paths.h"
 
 #include <gtkmm/main.h>
 #include <gtkmm2ext/popup.h>
 #include <gtkmm2ext/utils.h>
 
 #include "version.h"
+#include "utils.h"
 #include "ardour_ui.h"
 #include "opts.h"
+#include "enums.h"
 
 #include "i18n.h"
 
 using namespace Gtk;
-using namespace GTK_ARDOUR;
+using namespace ARDOUR_COMMAND_LINE;
 using namespace ARDOUR;
+using namespace PBD;
 using namespace sigc;
 
 TextReceiver text_receiver ("ardour");
@@ -60,324 +61,273 @@ TextReceiver text_receiver ("ardour");
 extern int curvetest (string);
 
 static ARDOUR_UI  *ui = 0;
+static const char* localedir = LOCALEDIR;
 
-static void
-shutdown (int status)
+void
+gui_jack_error ()
 {
-       char* msg;
-
-       if (status) {
-
-               msg = _("ardour is killing itself for a clean exit\n");
-               write (1, msg, strlen (msg));
-               /* drastic, but perhaps necessary */
-               kill (-getpgrp(), SIGKILL);     
-               /*NOTREACHED*/
+       MessageDialog win (_("Ardour could not connect to JACK."),
+                    false,
+                    Gtk::MESSAGE_INFO,
+                    (Gtk::ButtonsType)(Gtk::BUTTONS_NONE));
+win.set_secondary_text(_("There are several possible reasons:\n\
+\n\
+1) JACK is not running.\n\
+2) JACK is running as another user, perhaps root.\n\
+3) There is already another client called \"ardour\".\n\
+\n\
+Please consider the possibilities, and perhaps (re)start JACK."));
 
-       } else {
+       win.add_button (Stock::QUIT, RESPONSE_CLOSE);
+       win.set_default_response (RESPONSE_CLOSE);
+       
+       win.show_all ();
+       win.set_position (Gtk::WIN_POS_CENTER);
 
-               if (ui) {
-                       msg = _("stopping user interface\n");
-                       write (1, msg, strlen (msg));
-                       ui->kill();
-               }
-               
-               pthread_cancel_all ();
+       if (!no_splash) {
+               ui->hide_splash ();
        }
 
-       exit (status);
-}
-
-
-static void 
-handler (int sig)
-{
-       char buf[64];
-       int n;
-
-       /* XXX its doubtful that snprintf() is async-safe */
-       n = snprintf (buf, sizeof(buf), _("%d(%d): received signal %d\n"), getpid(), (int) pthread_self(), sig);
-       write (1, buf, n);
+       /* we just don't care about the result, but we want to block */
 
-       shutdown (1);
+       win.run ();
 }
 
-static void 
-handler2 (int sig, siginfo_t* ctxt, void* ignored)
-{
-       handler (sig);
-}      
-
-static void *
-signal_thread (void *arg)
-{
-       int sig;
-       sigset_t blocked;
 
-       PBD::ThreadCreated (pthread_self(), X_("Signal"));
+#ifdef __APPLE__
 
-       pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
-       
-       /* find out what's blocked right now */
+#include <mach-o/dyld.h>
+#include <sys/param.h>
+#include <fstream>
 
-       //sigprocmask (SIG_SETMASK, 0, &blocked);
-       if (pthread_sigmask (SIG_SETMASK, 0, &blocked)) {
-               cerr << "getting blocked signals failed\n";
+void
+fixup_bundle_environment ()
+{
+       if (!getenv ("ARDOUR_BUNDLED")) {
+               return;
        }
-       
-       /* wait for any of the currently blocked signals.
-          
-          According to the man page found in linux 2.6 and 2.4, sigwait() 
-          never returns an error. This is incorrect. Checking the man
-          pages for some other *nix systems makes it clear that
-          sigwait() can return several error codes, one of which 
-          is EINTR. This happens if the thread receives a signal
-          which is not in the blocked set. 
-
-          We do not expect that to happen, and if it did we should generally
-          exit as planned. However, under 2.6, the ptrace facility used 
-          by gdb seems to also cause sigwait() to return with EINTR
-          but with a signal that sigwait cannot understand. As a result, 
-          "sig" is set to zero, an impossible signal number.
-
-          Handling the EINTR code makes it possible to debug 
-          ardour on a 2.6 kernel.
 
-       */
-
-       int swerr;
-
-  again:
-       if ((swerr = sigwait (&blocked, &sig))) {
-               if (swerr == EINTR) {
-                       goto again;
-               } else {
-                       cerr << "sigwait failed with " << swerr << endl;
-               }
-       }
+       char execpath[MAXPATHLEN+1];
+       uint32_t pathsz = sizeof (execpath);
 
-       cerr << "Signal " << sig << " received\n";
+       _NSGetExecutablePath (execpath, &pathsz);
 
-       if (sig != SIGSEGV) {
+       Glib::ustring exec_path (execpath);
+       Glib::ustring dir_path = Glib::path_get_dirname (exec_path);
+       Glib::ustring path;
+       const char *cstr = getenv ("PATH");
 
-               /* unblock signals so we can see them during shutdown.
-                  this will help prod developers not to lose sight
-                  of bugs that cause segfaults etc. during shutdown.
-               */
+       /* ensure that we find any bundled executables (e.g. JACK),
+          and find them before any instances of the same name
+          elsewhere in PATH
+       */
 
-               sigprocmask (SIG_UNBLOCK, &blocked, 0);
+       path = dir_path;
+       if (cstr) {
+               path += ':';
+               path += cstr;
        }
-
-       shutdown (1);
-       /*NOTREACHED*/
-       return 0;
-}
-
-int
-catch_signals (void)
-{
-       struct sigaction action;
-       pthread_t signal_thread_id;
-       sigset_t signals;
-
-//     if (setpgid (0,0)) {
-       if (setsid ()) {
-               warning << string_compose (_("cannot become new process group leader (%1)"), 
-                                   strerror (errno))
-                       << endmsg;
+       setenv ("PATH", path.c_str(), 1);
+
+       path = dir_path;
+       path += "/../Resources";
+       path += dir_path;
+       path += "/../Resources/Surfaces";
+       path += dir_path;
+       path += "/../Resources/Panners";
+
+       setenv ("ARDOUR_MODULE_PATH", path.c_str(), 1);
+
+       path = dir_path;
+       path += "/../Resources/icons:";
+       path += dir_path;
+       path += "/../Resources/pixmaps:";
+       path += dir_path;
+       path += "/../Resources/share:";
+       path += dir_path;
+       path += "/../Resources";
+
+       setenv ("ARDOUR_PATH", path.c_str(), 1);
+       setenv ("ARDOUR_CONFIG_PATH", path.c_str(), 1);
+       setenv ("ARDOUR_DATA_PATH", path.c_str(), 1);
+
+       path = dir_path;
+       path += "/../Resources";
+       setenv ("ARDOUR_INSTANT_XML_PATH", path.c_str(), 1);
+
+       cstr = getenv ("LADSPA_PATH");
+       if (cstr) {
+               path = cstr;
+               path += ':';
+       } else {
+               path = "";
        }
-
-       sigemptyset (&signals);
-       sigaddset(&signals, SIGHUP);
-       sigaddset(&signals, SIGINT);
-       sigaddset(&signals, SIGQUIT);
-       sigaddset(&signals, SIGPIPE);
-       sigaddset(&signals, SIGTERM);
-       sigaddset(&signals, SIGUSR1);
-       sigaddset(&signals, SIGUSR2);
-
-
-       /* install a handler because otherwise
-          pthreads behaviour is undefined when we enter
-          sigwait.
-       */
-       
-       action.sa_handler = handler;
-       action.sa_mask = signals;
-       action.sa_flags = SA_RESTART|SA_RESETHAND;
-
-       for (int i = 1; i < 32; i++) {
-               if (sigismember (&signals, i)) {
-                       if (sigaction (i, &action, 0)) {
-                               cerr << string_compose (_("cannot setup signal handling for %1"), i) << endl;
-                               return -1;
-                       }
-               }
-       } 
-
-       /* this sets the signal mask for this and all 
-          subsequent threads that do not reset it.
-       */
+       path += dir_path;
+       path += "/../Plugins";
        
-       if (pthread_sigmask (SIG_SETMASK, &signals, 0)) {
-               cerr << string_compose (_("cannot set default signal mask (%1)"), strerror (errno)) << endl;
-               return -1;
-       }
+       setenv ("LADSPA_PATH", path.c_str(), 1);
 
-       /* start a thread to wait for signals */
-
-       if (pthread_create_and_store ("signal", &signal_thread_id, 0, signal_thread, 0)) {
-               cerr << "cannot create signal catching thread" << endl;
-               return -1;
+       cstr = getenv ("VAMP_PATH");
+       if (cstr) {
+               path = cstr;
+               path += ':';
+       } else {
+               path = "";
        }
+       path += dir_path;
+       path += "/../Frameworks";
+       
+       setenv ("VAMP_PATH", path.c_str(), 1);
 
-       pthread_detach (signal_thread_id);
-       return 0;
-}
-
-string
-which_ui_rcfile ()
-{
-       string rcfile;
-       char* env;
-
-       if ((env = getenv ("ARDOUR2_UI_RC")) != 0 && strlen (env)) {
-               rcfile = env;
+       cstr = getenv ("ARDOUR_CONTROL_SURFACE_PATH");
+       if (cstr) {
+               path = cstr;
+               path += ':';
        } else {
-               rcfile = "ardour2_ui.rc";
+               path = "";
        }
-
-       rcfile = find_config_file (rcfile);
+       path += dir_path;
+       path += "/../Surfaces";
        
-       if (rcfile.empty()) {
-               warning << _("Without a UI style file, ardour will look strange.\n Please set ARDOUR2_UI_RC to point to a valid UI style file") << endmsg;
+       setenv ("ARDOUR_CONTROL_SURFACE_PATH", path.c_str(), 1);
+
+       cstr = getenv ("LV2_PATH");
+       if (cstr) {
+               path = cstr;
+               path += ':';
        } else {
-               cerr << "Loading ui configuration file " << rcfile << endl;
+               path = "";
        }
+       path += dir_path;
+       path += "/../Plugins";
        
-       return rcfile;
-}
+       setenv ("LV2_PATH", path.c_str(), 1);
 
-gint
-show_ui_callback (void *arg)
-{
-       ARDOUR_UI * ui = (ARDOUR_UI *) arg;
+       path = dir_path;
+       path += "/../Frameworks/clearlooks";
 
-       ui->hide_splash();
-       ui->show ();
-       
-       return FALSE;
-}
+       setenv ("GTK_PATH", path.c_str(), 1);
 
-void
-gui_jack_error ()
-{
-  MessageDialog win (_("Ardour could not connect to JACK."),
-                    false,
-                    Gtk::MESSAGE_INFO,
-                    (Gtk::ButtonsType)(Gtk::BUTTONS_NONE));
-win.set_secondary_text(_("There are several possible reasons:\n\
-\n\
-1) JACK is not running.\n\
-2) JACK is running as another user, perhaps root.\n\
-3) There is already another client called \"ardour\".\n\
-\n\
-Please consider the possibilities, and perhaps (re)start JACK."));
-
-       win.add_button (Stock::QUIT, RESPONSE_CLOSE);
-       win.set_default_response (RESPONSE_CLOSE);
+       path = dir_path;
+       path += "/../Resources/locale";
        
-       win.show_all ();
-       win.set_position (Gtk::WIN_POS_CENTER);
-
-       /* we just don't care about the result */
+       localedir = strdup (path.c_str());
 
-       win.run ();
-}
+       /* write a pango.rc file and tell pango to use it. we'd love
+          to put this into the Ardour.app bundle and leave it there,
+          but the user may not have write permission. so ... 
 
-static bool
-maybe_load_session ()
-{
+          we also have to make sure that the user ardour directory
+          actually exists ...
+       */
 
-       /* load session, if given */
-       string name, path;
+       try {
+               sys::create_directories (user_config_directory ());
+       }
+       catch (const sys::filesystem_error& ex) {
+               error << _("Could not create user configuration directory") << endmsg;
+       }
+       
+       sys::path pangopath = user_config_directory();
+       pangopath /= "pango.rc";
+       path = pangopath.to_string();
+
+       std::ofstream pangorc (path.c_str());
+       if (!pangorc) {
+               error << string_compose (_("cannot open pango.rc file %1") , path) << endmsg;
+               return;
+       } else {
+               pangorc << "[Pango]\nModuleFiles=";
 
-       if (session_name.length()){
-               bool isnew;
+               pangopath = dir_path;
+               pangopath /= "..";
+               pangopath /= "Resources";
+               pangopath /= "pango.modules";
+                       
+               pangorc << pangopath.to_string() << endl;
 
-               if (Session::find_session (session_name, path, name, isnew)) {
-                       error << string_compose(_("could not load command line session \"%1\""), session_name) << endmsg;
-               } else {
+               pangorc.close ();
 
-                       if (new_session) {
+               setenv ("PANGO_RC_FILE", path.c_str(), 1);
+       }
 
-                               /* command line required that the session be new */
+       // gettext charset aliases
 
-                               if (isnew) {
-                                       
-                                       /* popup the new session dialog
-                                          once everything else is OK.
-                                       */
+       setenv ("CHARSETALIASDIR", path.c_str(), 1);
 
-                                       Glib::signal_idle().connect (bind (mem_fun (*ui, &ARDOUR_UI::cmdline_new_session), path));
-                                       ui->set_will_create_new_session_automatically (true);
+       // font config
+       
+       path = dir_path;
+       path += "/../Resources/fonts.conf";
 
-                               } else {
+       setenv ("FONTCONFIG_FILE", path.c_str(), 1);
 
-                                       /* it wasn't new, but we require a new session */
+       // GDK Pixbuf loader module file
 
-                                       error << string_compose (_("\n\nA session named \"%1\" already exists.\n\
-To avoid this message, start ardour as \"ardour %1"), path)
-                                             << endmsg;
-                                       return false;
-                               }
+       path = dir_path;
+       path += "/../Resources/gdk-pixbuf.loaders";
 
-                       } else {
+       setenv ("GDK_PIXBUF_MODULE_FILE", path.c_str(), 1);
 
-                               /* command line didn't require a new session */
-                               
-                               if (isnew) {
-                                       error << string_compose (_("\n\nNo session named \"%1\" exists.\n\
-To create it from the command line, start ardour as \"ardour --new %1"), path) 
-                                             << endmsg;
-                                       return false;
-                               }
+       if (getenv ("ARDOUR_WITH_JACK")) {
+               // JACK driver dir
+               
+               path = dir_path;
+               path += "/../Frameworks";
+               
+               setenv ("JACK_DRIVER_DIR", path.c_str(), 1);
+       }
+}
 
-                               ui->load_session (path, name);
-                       }
-               }
+#endif
 
-               if (no_splash) {
-                       ui->show();
-               }
+static void
+sigpipe_handler (int sig)
+{
+       cerr << _("SIGPIPE received - JACK has probably died") << endl;
+}
 
-       } else {
-               ui->hide_splash ();
-               if (!Config->get_no_new_session_dialog()) {
-                      ui->new_session (true);
-               }
-       }
+#ifdef VST_SUPPORT
 
-       return true;
-}
+extern int gui_init (int* argc, char** argv[]);
 
-int
-main (int argc, char *argv[])
+/* this is called from the entry point of a wine-compiled
+   executable that is linked against gtk2_ardour built
+   as a shared library.
+*/
+extern "C" {
+int ardour_main (int argc, char *argv[])
+#else
+int main (int argc, char *argv[])
+#endif
 {
-       ARDOUR::AudioEngine *engine;
        vector<Glib::ustring> null_file_list;
+       
+#ifdef __APPLE__
+       fixup_bundle_environment ();
+#endif
 
-        // needs a better home.
         Glib::thread_init();
-        
        gtk_set_locale ();
 
-       (void)   bindtextdomain (PACKAGE, LOCALEDIR);
+#ifdef VST_SUPPORT
+       /* this does some magic that is needed to make GTK and Wine's own
+          X11 client interact properly.
+       */
+       gui_init (&argc, &argv);
+#endif
+
+       (void) bindtextdomain (PACKAGE, localedir);
+       /* our i18n translations are all in UTF-8, so make sure
+          that even if the user locale doesn't specify UTF-8,
+          we use that when handling them.
+       */
+       (void) bind_textdomain_codeset (PACKAGE,"UTF-8");
        (void) textdomain (PACKAGE);
 
        pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
 
-       // catch_signals ();
+       // catch error message system signals ();
 
        text_receiver.listen_to (error);
        text_receiver.listen_to (info);
@@ -395,13 +345,7 @@ main (int argc, char *argv[])
        cout << _("Ardour/GTK ") 
             << VERSIONSTRING
             << _("\n   (built using ")
-            << gtk_ardour_major_version << '.'
-            << gtk_ardour_minor_version << '.'
-            << gtk_ardour_micro_version
-            << _(" with libardour ")
-            << libardour_major_version << '.'
-            << libardour_minor_version << '.' 
-            << libardour_micro_version 
+            << svn_revision
 #ifdef __GNUC__
             << _(" and GCC version ") << __VERSION__ 
 #endif
@@ -413,7 +357,7 @@ main (int argc, char *argv[])
        }
 
        if (no_splash) {
-               cerr << _("Copyright (C) 1999-2006 Paul Davis") << endl
+               cerr << _("Copyright (C) 1999-2008 Paul Davis") << endl
                     << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker") << endl
                     << endl
                     << _("Ardour comes with ABSOLUTELY NO WARRANTY") << endl
@@ -423,46 +367,29 @@ main (int argc, char *argv[])
                     << endl;
        }
 
-       try { 
-               ui = new ARDOUR_UI (&argc, &argv, which_ui_rcfile());
-       } 
-
-       catch (failed_constructor& err) {
-               error << _("could not create ARDOUR GUI") << endmsg;
-               exit (1);
-       }
+       /* some GUI objects need this */
 
+       PBD::ID::init ();
 
-       if (!no_splash) {
-               ui->show_splash ();
-               if (session_name.length()) {  
-                       gtk_timeout_add (4000, show_ui_callback, ui);
-               }
+       if (::signal (SIGPIPE, sigpipe_handler)) {
+               cerr << _("Cannot install SIGPIPE error handler") << endl;
        }
-       
-       try { 
-               engine = new ARDOUR::AudioEngine (jack_client_name);
-               ARDOUR::init (*engine, use_vst, try_hw_optimization, handler2);
-               ui->set_engine (*engine);
-       } catch (AudioEngine::NoBackendAvailable& err) {
-               gui_jack_error ();
-               error << string_compose (_("Could not connect to JACK server as  \"%1\""), jack_client_name) <<  endmsg;
-               return -1;
-       } catch (failed_constructor& err) {
-               error << _("could not initialize Ardour.") << endmsg;
-               return -1;
-       } 
 
-       if (maybe_load_session ()) {
-               ui->run (text_receiver);
-               ui = 0;
+        try { 
+               ui = new ARDOUR_UI (&argc, &argv);
+       } catch (failed_constructor& err) {
+               error << _("could not create ARDOUR GUI") << endmsg;
+               exit (1);
        }
 
-  out:
-       delete engine;
-       ARDOUR::cleanup ();
-       shutdown (0);
+       ui->run (text_receiver);
+       ui = 0;
 
-       /* just another commit forcing change */
+       ARDOUR::cleanup ();
+       pthread_cancel_all ();
+       return 0;
 }
+#ifdef VST_SUPPORT
+} // end of extern C block
+#endif