merge with master.
[ardour.git] / gtk2_ardour / main.cc
index 5a4bff016731f37f550ca3ce2f4eff5a33542565..d924d9b30a6f55243a2e885b47f0830cb7879956 100644 (file)
 #include <gtkmm/settings.h>
 
 #include "pbd/error.h"
-#include "pbd/epa.h"
 #include "pbd/file_utils.h"
 #include "pbd/textreceiver.h"
 #include "pbd/failed_constructor.h"
+#include "pbd/pathexpand.h"
 #include "pbd/pthread_utils.h"
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
 #include "pbd/boost_debug.h"
 #endif
 
-#include <jack/jack.h>
-
-#include "ardour/svn_revision.h"
+#include "ardour/revision.h"
 #include "ardour/version.h"
 #include "ardour/ardour.h"
 #include "ardour/audioengine.h"
 #include <gtkmm2ext/utils.h>
 
 #include "version.h"
-#include "utils.h"
 #include "ardour_ui.h"
 #include "opts.h"
 #include "enums.h"
+#include "bundle_env.h"
 
 #include "i18n.h"
 
+#ifdef COMPILER_MSVC
+#include <fcntl.h> // Needed for '_fmode'
+#endif
+
 using namespace std;
 using namespace Gtk;
 using namespace ARDOUR_COMMAND_LINE;
@@ -74,17 +76,10 @@ static const char* localedir = LOCALEDIR;
 void
 gui_jack_error ()
 {
-       MessageDialog win (string_compose (_("%1 could not connect to JACK."), PROGRAM_NAME),
+       MessageDialog win (string_compose (_("%1 could not connect to the audio backend."), PROGRAM_NAME),
                           false,
                           Gtk::MESSAGE_INFO,
                           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);
@@ -101,254 +96,31 @@ Please consider the possibilities, and perhaps (re)start JACK."));
        win.run ();
 }
 
-static void export_search_path (const string& base_dir, const char* varname, const char* dir)
-{
-       string path;
-       const char * cstr = getenv (varname);
-
-       if (cstr) {
-               path = cstr;
-               path += ':';
-       } else {
-               path = "";
-       }
-       path += base_dir;
-       path += dir;
-
-       setenv (varname, path.c_str(), 1);
-}
-
-#ifdef __APPLE__
-
-#include <mach-o/dyld.h>
-#include <sys/param.h>
-
-extern void set_language_preference (); // cocoacarbon.mm
-
-void
-fixup_bundle_environment (int, char* [])
-{
-       if (!getenv ("ARDOUR_BUNDLED")) {
-               return;
-       }
-
-       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
-
-       set_language_preference ();
-
-       char execpath[MAXPATHLEN+1];
-       uint32_t pathsz = sizeof (execpath);
-
-       _NSGetExecutablePath (execpath, &pathsz);
-
-       std::string path;
-       std::string exec_dir = Glib::path_get_dirname (execpath);
-       std::string bundle_dir;
-       std::string userconfigdir = user_config_directory();
-
-       bundle_dir = Glib::path_get_dirname (exec_dir);
-
-       /* force localedir into the bundle */
-
-       vector<string> lpath;
-       lpath.push_back (bundle_dir);
-       lpath.push_back ("share");
-       lpath.push_back ("locale");
-       localedir = strdup (Glib::build_filename (lpath).c_str());
-
-       export_search_path (bundle_dir, "ARDOUR_DLL_PATH", "/lib");
-
-       /* inside an OS X .app bundle, there is no difference
-          between DATA and CONFIG locations, since OS X doesn't
-          attempt to do anything to expose the notion of
-          machine-independent shared data.
-       */
-
-       export_search_path (bundle_dir, "ARDOUR_DATA_PATH", "/Resources");
-       export_search_path (bundle_dir, "ARDOUR_CONFIG_PATH", "/Resources");
-       export_search_path (bundle_dir, "ARDOUR_INSTANT_XML_PATH", "/Resources");
-       export_search_path (bundle_dir, "LADSPA_PATH", "/Plugins");
-       export_search_path (bundle_dir, "VAMP_PATH", "/lib");
-       export_search_path (bundle_dir, "SUIL_MODULE_DIR", "/lib");
-       export_search_path (bundle_dir, "GTK_PATH", "/lib/clearlooks");
-
-       /* unset GTK_RC_FILES so that we only load the RC files that we define
-        */
-
-       unsetenv ("GTK_RC_FILES");
-
-       if (!ARDOUR::translations_are_disabled ()) {
-               export_search_path (bundle_dir, "GTK_LOCALEDIR", "/Resources/locale");
-       }
-
-       /* write a pango.rc file and tell pango to use it. we'd love
-          to put this into the PROGRAM_NAME.app bundle and leave it there,
-          but the user may not have write permission. so ...
-
-          we also have to make sure that the user ardour directory
-          actually exists ...
-       */
-
-       if (g_mkdir_with_parents (userconfigdir.c_str(), 0755) < 0) {
-               error << string_compose (_("cannot create user ardour folder %1 (%2)"), userconfigdir, strerror (errno))
-                     << endmsg;
-       } else {
-               
-               path = Glib::build_filename (userconfigdir, "pango.rc");
-               std::ofstream pangorc (path.c_str());
-               if (!pangorc) {
-                       error << string_compose (_("cannot open pango.rc file %1") , path) << endmsg;
-               } else {
-                       pangorc << "[Pango]\nModuleFiles="
-                               << Glib::build_filename (bundle_dir, "Resources/pango.modules") 
-                               << endl;
-                       pangorc.close ();
-                       
-                       setenv ("PANGO_RC_FILE", path.c_str(), 1);
-               }
-       }
-       
-       setenv ("CHARSETALIASDIR", bundle_dir.c_str(), 1);
-       setenv ("FONTCONFIG_FILE", Glib::build_filename (bundle_dir, "Resources/fonts.conf").c_str(), 1);
-       setenv ("GDK_PIXBUF_MODULE_FILE", Glib::build_filename (bundle_dir, "Resources/gdk-pixbuf.loaders").c_str(), 1);
-}
-
-#else
-
-void
-fixup_bundle_environment (int /*argc*/, char* argv[])
-{
-       /* THIS IS FOR LINUX - its just about the only place where its
-        * acceptable to build paths directly using '/'.
-        */
-
-       if (!getenv ("ARDOUR_BUNDLED")) {
-               return;
-       }
-
-       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
-
-       std::string path;
-       std::string dir_path = Glib::path_get_dirname (Glib::path_get_dirname (argv[0]));
-       std::string userconfigdir = user_config_directory();
-
-       /* force localedir into the bundle */
-
-       vector<string> lpath;
-       lpath.push_back (dir_path);
-       lpath.push_back ("share");
-       lpath.push_back ("locale");
-       localedir = realpath (Glib::build_filename (lpath).c_str(), NULL);
-
-       /* note that this function is POSIX/Linux specific, so using / as
-          a dir separator in this context is just fine.
-       */
-
-       export_search_path (dir_path, "ARDOUR_DLL_PATH", "/lib");
-       export_search_path (dir_path, "ARDOUR_CONFIG_PATH", "/etc");
-       export_search_path (dir_path, "ARDOUR_INSTANT_XML_PATH", "/share");
-       export_search_path (dir_path, "ARDOUR_DATA_PATH", "/share");
-       export_search_path (dir_path, "LADSPA_PATH", "/plugins");
-       export_search_path (dir_path, "VAMP_PATH", "/lib");
-       export_search_path (dir_path, "SUIL_MODULE_DIR", "/lib");
-
-       export_search_path (dir_path, "GTK_PATH", "/lib/clearlooks");
-
-       /* unset GTK_RC_FILES so that we only load the RC files that we define
-        */
-
-       unsetenv ("GTK_RC_FILES");
-
-       if (!ARDOUR::translations_are_disabled ()) {
-               export_search_path (dir_path, "GTK_LOCALEDIR", "/share/locale");
-       }
-
-       /* Tell fontconfig where to find fonts.conf. Use the system version
-          if it exists, otherwise use the stuff we included in the bundle
-       */
-
-       if (Glib::file_test ("/etc/fonts/fonts.conf", Glib::FILE_TEST_EXISTS)) {
-               setenv ("FONTCONFIG_FILE", "/etc/fonts/fonts.conf", 1);
-               setenv ("FONTCONFIG_PATH", "/etc/fonts", 1);
-       } else {
-               /* use the one included in the bundle */
-               
-               path = Glib::build_filename (dir_path, "etc/fonts/fonts.conf");
-               setenv ("FONTCONFIG_FILE", path.c_str(), 1);
-               export_search_path (dir_path, "FONTCONFIG_PATH", "/etc/fonts");
-       }
-
-       /* 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 ...
-
-          we also have to make sure that the user ardour directory
-          actually exists ...
-       */
-
-       if (g_mkdir_with_parents (userconfigdir.c_str(), 0755) < 0) {
-               error << string_compose (_("cannot create user ardour folder %1 (%2)"), userconfigdir, strerror (errno))
-                     << endmsg;
-       } else {
-               
-               path = Glib::build_filename (userconfigdir, "pango.rc");
-               std::ofstream pangorc (path.c_str());
-               if (!pangorc) {
-                       error << string_compose (_("cannot open pango.rc file %1") , path) << endmsg;
-               } else {
-                       pangorc << "[Pango]\nModuleFiles="
-                               << Glib::build_filename (userconfigdir, "pango.modules")
-                               << endl;
-                       pangorc.close ();
-               }
-               
-               setenv ("PANGO_RC_FILE", path.c_str(), 1);
-               
-               /* similar for GDK pixbuf loaders, but there's no RC file required
-                  to specify where it lives.
-               */
-               
-               setenv ("GDK_PIXBUF_MODULE_FILE", Glib::build_filename (userconfigdir, "gdk-pixbuf.loaders").c_str(), 1);
-       }
-
-        /* this doesn't do much but setting it should prevent various parts of the GTK/GNU stack
-           from looking outside the bundle to find the charset.alias file.
-        */
-        setenv ("CHARSETALIASDIR", dir_path.c_str(), 1);
-
-}
-
-#endif
-
 static gboolean
-tell_about_jack_death (void* /* ignored */)
+tell_about_backend_death (void* /* ignored */)
 {
        if (AudioEngine::instance()->processed_frames() == 0) {
                /* died during startup */
-               MessageDialog msg (_("JACK exited"), false);
+               MessageDialog msg (string_compose (_("The audio backend (%1) has failed, or terminated"), AudioEngine::instance()->current_backend_name()), false);
                msg.set_position (Gtk::WIN_POS_CENTER);
                msg.set_secondary_text (string_compose (_(
-"JACK exited unexpectedly, and without notifying %1.\n\
+"%2 exited unexpectedly, and without notifying %1.\n\
 \n\
-This could be due to misconfiguration or to an error inside JACK.\n\
+This could be due to misconfiguration or to an error inside %2.\n\
 \n\
-Click OK to exit %1."), PROGRAM_NAME));
+Click OK to exit %1."), PROGRAM_NAME, AudioEngine::instance()->current_backend_name()));
 
                msg.run ();
                _exit (0);
 
        } else {
 
-               /* engine has already run, so this is a mid-session JACK death */
-
-               MessageDialog* msg = manage (new MessageDialog (_("JACK exited"), false));
-               msg->set_secondary_text (string_compose (_(
-"JACK exited unexpectedly, and without notifying %1.\n\
-\n\
-This is probably due to an error inside JACK. You should restart JACK\n\
-and reconnect %1 to it, or exit %1 now. You cannot save your\n\
-session at this time, because we would lose your connection information.\n"), PROGRAM_NAME));
-               msg->present ();
+               /* engine has already run, so this is a mid-session backend death */
+                       
+               MessageDialog msg (string_compose (_("The audio backend (%1) has failed, or terminated"), AudioEngine::instance()->current_backend_name()), false);
+               msg.set_secondary_text (string_compose (_("%2 exited unexpectedly, and without notifying %1."),
+                                                        PROGRAM_NAME, AudioEngine::instance()->current_backend_name()));
+               msg.present ();
        }
        return false; /* do not call again */
 }
@@ -356,20 +128,27 @@ session at this time, because we would lose your connection information.\n"), PR
 static void
 sigpipe_handler (int /*signal*/)
 {
-       /* XXX fix this so that we do this again after a reconnect to JACK
+       /* XXX fix this so that we do this again after a reconnect to the backend
         */
 
-       static bool done_the_jack_thing = false;
+       static bool done_the_backend_thing = false;
 
-       if (!done_the_jack_thing) {
+       if (!done_the_backend_thing) {
                AudioEngine::instance()->died ();
-               g_idle_add (tell_about_jack_death, 0);
-               done_the_jack_thing =  true;
+               g_idle_add (tell_about_backend_death, 0);
+               done_the_backend_thing =  true;
        }
 }
 
-#ifdef WINDOWS_VST_SUPPORT
+#if (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
+/*
+ *  Release build with MSVC uses ardour_main()
+ */
+int ardour_main (int argc, char *argv[])
 
+#elif (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
+
+// prototype for function in windows_vst_plugin_ui.cc
 extern int windows_vst_gui_init (int* argc, char** argv[]);
 
 /* this is called from the entry point of a wine-compiled
@@ -377,28 +156,40 @@ extern int windows_vst_gui_init (int* argc, char** argv[]);
    as a shared library.
 */
 extern "C" {
+
 int ardour_main (int argc, char *argv[])
+
 #else
 int main (int argc, char *argv[])
 #endif
 {
-       fixup_bundle_environment (argc, argv);
+#ifdef COMPILER_MSVC
+       // Essential!!  Make sure that any files used by Ardour
+       //              will be created or opened in BINARY mode!
+       _fmode = O_BINARY;
+#endif
+
+       fixup_bundle_environment (argc, argv, &localedir);
+
+       load_custom_fonts(); /* needs to happen before any gtk and pango init calls */
 
        if (!Glib::thread_supported()) {
                Glib::thread_init();
        }
 
+#ifdef ENABLE_NLS
        gtk_set_locale ();
+#endif
 
-#ifdef WINDOWS_VST_SUPPORT
-       /* this does some magic that is needed to make GTK and Wine's own
-          X11 client interact properly.
-       */
+#if (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
+       /* this does some magic that is needed to make GTK and X11 client interact properly.
+        * the platform dependent code is in windows_vst_plugin_ui.cc
+        */
        windows_vst_gui_init (&argc, &argv);
 #endif
 
 #ifdef ENABLE_NLS
-       cerr << "bnd txt domain [" << PACKAGE << "] to " << localedir << endl;
+       cerr << "bind txt domain [" << PACKAGE << "] to " << localedir << endl;
 
        (void) bindtextdomain (PACKAGE, localedir);
        /* our i18n translations are all in UTF-8, so make sure
@@ -406,7 +197,6 @@ int main (int argc, char *argv[])
           we use that when handling them.
        */
        (void) bind_textdomain_codeset (PACKAGE,"UTF-8");
-       (void) textdomain (PACKAGE);
 #endif
 
        pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
@@ -419,23 +209,29 @@ int main (int argc, char *argv[])
        text_receiver.listen_to (warning);
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-       if (getenv ("BOOST_DEBUG")) {
+       if (g_getenv ("BOOST_DEBUG")) {
                boost_debug_shared_ptr_show_live_debugging (true);
        }
 #endif
 
        if (parse_opts (argc, argv)) {
+#if (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
+        // Since we don't ordinarily have access to stdout and stderr with
+        // an MSVC app, let the user know we encountered a parsing error.
+        Gtk::Main app(&argc, &argv); // Calls 'gtk_init()'
+
+        Gtk::MessageDialog dlgReportParseError (_("\n   Ardour could not understand your command line      "),
+                                                      false, MESSAGE_ERROR, BUTTONS_CLOSE, true);
+        dlgReportParseError.set_title (_("An error was encountered while launching Ardour"));
+               dlgReportParseError.run ();
+#endif
                exit (1);
        }
 
-       if (curvetest_file) {
-               return curvetest (curvetest_file);
-       }
-
        cout << PROGRAM_NAME
             << VERSIONSTRING
             << _(" (built using ")
-            << svn_revision
+            << revision
 #ifdef __GNUC__
             << _(" and GCC version ") << __VERSION__
 #endif
@@ -459,21 +255,31 @@ int main (int argc, char *argv[])
 
        /* some GUI objects need this */
 
-       PBD::ID::init ();
+       if (!ARDOUR::init (ARDOUR_COMMAND_LINE::use_vst, ARDOUR_COMMAND_LINE::try_hw_optimization, localedir)) {
+               error << string_compose (_("could not initialize %1."), PROGRAM_NAME) << endmsg;
+               exit (1);
+       }
 
+       if (curvetest_file) {
+               return curvetest (curvetest_file);
+       }
+
+#ifndef PLATFORM_WINDOWS
        if (::signal (SIGPIPE, sigpipe_handler)) {
                cerr << _("Cannot xinstall SIGPIPE error handler") << endl;
        }
+#endif
 
        try {
                ui = new ARDOUR_UI (&argc, &argv, localedir);
        } catch (failed_constructor& err) {
-               error << _("could not create ARDOUR GUI") << endmsg;
+               error << string_compose (_("could not create %1 GUI"), PROGRAM_NAME) << endmsg;
                exit (1);
        }
 
        ui->run (text_receiver);
        Gtkmm2ext::Application::instance()->cleanup();
+       delete ui;
        ui = 0;
 
        ARDOUR::cleanup ();
@@ -481,7 +287,6 @@ int main (int argc, char *argv[])
 
        return 0;
 }
-#ifdef WINDOWS_VST_SUPPORT
-} // end of extern C block
+#if (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
+} // end of extern "C" block
 #endif
-