/*
- Copyright (C) 2001-2006 Paul Davis
-
+ Copyright (C) 2001-2012 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
the Free Software Foundation; either version 2 of the License, or
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 <cerrno>
+#include <vector>
+
#include <signal.h>
-#include <unistd.h>
+#include <locale.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>
+#ifdef HAVE_FFTW35F
+#include <fftw3.h>
+#endif
-#include <jack/jack.h>
+#include <curl/curl.h>
-#include <ardour/version.h>
-#include <ardour/ardour.h>
-#include <ardour/audioengine.h>
+#include "pbd/error.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 "ardour/revision.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 <gtkmm/stock.h>
+
+#include <gtkmm2ext/application.h>
#include <gtkmm2ext/utils.h>
-#include "svn_revision.h"
-#include "version.h"
#include "ardour_ui.h"
+#include "ui_config.h"
#include "opts.h"
#include "enums.h"
+#include "bundle_env.h"
+
+#include "pbd/i18n.h"
-#include "i18n.h"
+#ifdef PLATFORM_WINDOWS
+#include <fcntl.h> // Needed for '_fmode'
+#include <shellapi.h> // console
+#endif
+
+#ifdef WAF_BUILD
+#include "gtk2ardour-version.h"
+#endif
+
+#ifdef LXVST_SUPPORT
+#include <gdk/gdkx.h>
+#endif
+using namespace std;
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");
extern int curvetest (string);
static ARDOUR_UI *ui = 0;
+static string localedir (LOCALEDIR);
-static void
-shutdown (int status)
+void
+gui_jack_error ()
{
- char* msg;
-
- if (status) {
+ MessageDialog win (string_compose (_("%1 could not connect to the audio backend."), PROGRAM_NAME),
+ false,
+ Gtk::MESSAGE_INFO,
+ Gtk::BUTTONS_NONE);
- msg = _("ardour is killing itself for a clean exit\n");
- write (1, msg, strlen (msg));
- /* drastic, but perhaps necessary */
- kill (-getpgrp(), SIGKILL);
- /*NOTREACHED*/
+ win.add_button (Stock::QUIT, RESPONSE_CLOSE);
+ win.set_default_response (RESPONSE_CLOSE);
- } else {
+ win.show_all ();
+ win.set_position (Gtk::WIN_POS_CENTER);
- if (ui) {
- ui->kill();
- }
-
- pthread_cancel_all ();
+ if (!no_splash) {
+ ui->hide_splash ();
}
- exit (status);
+ /* we just don't care about the result, but we want to block */
+
+ win.run ();
}
+#ifndef NDEBUG
+static void ardour_g_log (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data) {
+ switch (log_level) {
+ case G_LOG_FLAG_FATAL:
+ case G_LOG_LEVEL_CRITICAL:
+ fatal << "g_log: " << message << endmsg;
+ break;
+ case G_LOG_LEVEL_ERROR:
+ error << "g_log: " << message << endmsg;
+ break;
+ case G_LOG_LEVEL_WARNING:
+ warning << "g_log: " << message << endmsg;
+ break;
+ case G_LOG_LEVEL_MESSAGE:
+ case G_LOG_LEVEL_INFO:
+ default:
+ info << "g_log: " << message << endmsg;
+ break;
+ }
+}
+#endif
-static void
-handler (int sig)
+static gboolean
+tell_about_backend_death (void* /* ignored */)
{
- char buf[64];
- int n;
+ if (AudioEngine::instance()->processed_samples() == 0) {
+ /* died during startup */
+ 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 (_(
+"%2 exited unexpectedly, and without notifying %1.\n\
+\n\
+This could be due to misconfiguration or to an error inside %2.\n\
+\n\
+Click OK to exit %1."), PROGRAM_NAME, AudioEngine::instance()->current_backend_name()));
+
+ msg.run ();
+ _exit (0);
+
+ } else {
- /* 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);
+ /* engine has already run, so this is a mid-session backend death */
- shutdown (1);
+ 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 */
}
-static void *
-signal_thread (void *arg)
+#ifndef PLATFORM_WINDOWS
+static void
+sigpipe_handler (int /*signal*/)
{
- int sig;
- sigset_t blocked;
+ /* XXX fix this so that we do this again after a reconnect to the backend */
- PBD::ThreadCreated (pthread_self(), X_("Signal"));
+ static bool done_the_backend_thing = false;
- pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
-
- /* find out what's blocked right now */
-
- //sigprocmask (SIG_SETMASK, 0, &blocked);
- if (pthread_sigmask (SIG_SETMASK, 0, &blocked)) {
- cerr << "getting blocked signals failed\n";
+ if (!done_the_backend_thing) {
+ AudioEngine::instance()->died ();
+ g_idle_add (tell_about_backend_death, 0);
+ done_the_backend_thing = true;
}
-
- /* 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.
-
- */
+}
+#endif
- int swerr;
+#if (!defined COMPILER_MSVC && defined PLATFORM_WINDOWS)
- again:
- if ((swerr = sigwait (&blocked, &sig))) {
- if (swerr == EINTR) {
- goto again;
- } else {
- cerr << "sigwait failed with " << swerr << endl;
- }
- }
+static FILE* pStdOut = 0;
+static FILE* pStdErr = 0;
+static BOOL bConsole;
+static HANDLE hStdOut;
- cerr << "Signal " << sig << " received\n";
+static bool
+IsAConsolePort (HANDLE handle)
+{
+ DWORD mode;
+ return (GetConsoleMode(handle, &mode) != 0);
+}
- if (sig != SIGSEGV) {
+static void
+console_madness_begin ()
+{
+ bConsole = AttachConsole(ATTACH_PARENT_PROCESS);
+ hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
- /* 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.
- */
+ /* re-attach to the console so we can see 'printf()' output etc.
+ * for MSVC see gtk2_ardour/msvc/winmain.cc
+ */
- sigprocmask (SIG_UNBLOCK, &blocked, 0);
+ if ((bConsole) && (IsAConsolePort(hStdOut))) {
+ pStdOut = freopen( "CONOUT$", "w", stdout );
+ pStdErr = freopen( "CONOUT$", "w", stderr );
}
-
- shutdown (1);
- /*NOTREACHED*/
- return 0;
}
-int
-catch_signals (void)
+static void
+console_madness_end ()
{
- 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;
+ if (pStdOut) {
+ fclose (pStdOut);
+ }
+ if (pStdErr) {
+ fclose (pStdErr);
}
- sigemptyset (&signals);
- sigaddset(&signals, SIGHUP);
- sigaddset(&signals, SIGINT);
- sigaddset(&signals, SIGQUIT);
- sigaddset(&signals, SIGPIPE);
- sigaddset(&signals, SIGTERM);
- sigaddset(&signals, SIGUSR1);
- sigaddset(&signals, SIGUSR2);
-
+ if (bConsole) {
+ // Detach and free the console from our application
+ INPUT_RECORD input_record;
- /* 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.
- */
-
- if (pthread_sigmask (SIG_SETMASK, &signals, 0)) {
- cerr << string_compose (_("cannot set default signal mask (%1)"), strerror (errno)) << endl;
- return -1;
- }
+ input_record.EventType = KEY_EVENT;
+ input_record.Event.KeyEvent.bKeyDown = TRUE;
+ input_record.Event.KeyEvent.dwControlKeyState = 0;
+ input_record.Event.KeyEvent.uChar.UnicodeChar = VK_RETURN;
+ input_record.Event.KeyEvent.wRepeatCount = 1;
+ input_record.Event.KeyEvent.wVirtualKeyCode = VK_RETURN;
+ input_record.Event.KeyEvent.wVirtualScanCode = MapVirtualKey( VK_RETURN, 0 );
- /* start a thread to wait for signals */
+ DWORD written = 0;
+ WriteConsoleInput( GetStdHandle( STD_INPUT_HANDLE ), &input_record, 1, &written );
- if (pthread_create_and_store ("signal", &signal_thread_id, 0, signal_thread, 0)) {
- cerr << "cannot create signal catching thread" << endl;
- return -1;
+ FreeConsole();
}
-
- pthread_detach (signal_thread_id);
- return 0;
}
-string
-which_ui_rcfile ()
-{
- string rcfile;
- char* env;
+static void command_line_parse_error (int *argc, char** argv[]) {}
- if ((env = getenv ("ARDOUR2_UI_RC")) != 0 && strlen (env)) {
- rcfile = env;
- } else {
- rcfile = "ardour2_ui.rc";
- }
+#elif (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
- rcfile = find_config_file (rcfile);
-
- 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;
- } else {
- cerr << "Loading ui configuration file " << rcfile << endl;
- }
-
- return rcfile;
-}
+// these are not used here. for MSVC see gtk2_ardour/msvc/winmain.cc
+static void console_madness_begin () {}
+static void console_madness_end () {}
-gint
-show_ui_callback (void *arg)
-{
- ARDOUR_UI * ui = (ARDOUR_UI *) arg;
+static void command_line_parse_error (int *argc, char** argv[]) {
+ // 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()'
- ui->hide_splash();
-
- return FALSE;
+ Gtk::MessageDialog dlgReportParseError (string_compose (_("\n %1 could not understand your command line "), PROGRAM_NAME),
+ false, MESSAGE_ERROR, BUTTONS_CLOSE, true);
+ dlgReportParseError.set_title (string_compose (_("An error was encountered while launching %1"), PROGRAM_NAME));
+ dlgReportParseError.run ();
}
-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."));
+#else
+static void console_madness_begin () {}
+static void console_madness_end () {}
+static void command_line_parse_error (int *argc, char** argv[]) {}
+#endif
- win.add_button (Stock::QUIT, RESPONSE_CLOSE);
- win.set_default_response (RESPONSE_CLOSE);
-
- win.show_all ();
- win.set_position (Gtk::WIN_POS_CENTER);
+#if (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
+/*
+ * Release build with MSVC uses ardour_main()
+ */
+int ardour_main (int argc, char *argv[])
- if (!no_splash) {
- ui->hide_splash ();
- }
+#elif (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
- /* we just don't care about the result, but we want to block */
+// prototype for function in windows_vst_plugin_ui.cc
+extern int windows_vst_gui_init (int* argc, char** argv[]);
- win.run ();
-}
+/* 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" {
-static bool
-maybe_load_session ()
+int ardour_main (int argc, char *argv[])
+
+#elif defined NOMAIN
+int nomain (int argc, char *argv[])
+#else
+int main (int argc, char *argv[])
+#endif
{
- /* If no session name is given: we're not loading a session yet, nor creating a new one */
- if (!session_name.length()) {
- ui->hide_splash ();
- if (!Config->get_no_new_session_dialog()) {
- ui->new_session ();
- }
+ ARDOUR::check_for_old_configuration_files();
- return true;
+ /* global init is not thread safe.*/
+ if (curl_global_init (CURL_GLOBAL_DEFAULT)) {
+ cerr << "curl_global_init() failed. The web is gone. We're all doomed." << endl;
}
- /* Load session or start the new session dialog */
- string name, path;
+ fixup_bundle_environment (argc, argv, localedir);
- bool isnew;
+ load_custom_fonts(); /* needs to happen before any gtk and pango init calls */
- if (Session::find_session (session_name, path, name, isnew)) {
- error << string_compose(_("could not load command line session \"%1\""), session_name) << endmsg;
- return false;
+ if (!Glib::thread_supported()) {
+ Glib::thread_init();
}
- if (!new_session) {
-
- /* Loading a session, but the session doesn't exist */
- 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 (ui->load_session (path, name)) {
- /* it failed */
- return false;
- }
+#ifdef LXVST_SUPPORT
+ XInitThreads ();
+#endif
- } else {
+#ifdef HAVE_FFTW35F
+ fftwf_make_planner_thread_safe ();
+#endif
- /* TODO: This bit of code doesn't work properly yet
- Glib::signal_idle().connect (bind (mem_fun (*ui, &ARDOUR_UI::cmdline_new_session), path));
- ui->set_will_create_new_session_automatically (true);
- */
-
- /* Show the NSD */
- ui->hide_splash ();
- if (!Config->get_no_new_session_dialog()) {
- ui->new_session ();
- }
+#if ENABLE_NLS
+ /* initialize C locale to user preference */
+ if (ARDOUR::translations_are_enabled ()) {
+ setlocale (LC_ALL, "");
}
+#endif
- return true;
-}
+ console_madness_begin();
-#ifdef VST_SUPPORT
-/* 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[])
+#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
-{
- ARDOUR::AudioEngine *engine;
- vector<Glib::ustring> null_file_list;
-
- Glib::thread_init();
- gtk_set_locale ();
+#if ENABLE_NLS
+ cerr << "bind txt domain [" << PACKAGE << "] to " << localedir << endl;
- (void) bindtextdomain (PACKAGE, LOCALEDIR);
+ (void) bindtextdomain (PACKAGE, localedir.c_str());
/* 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);
+#endif
pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
text_receiver.listen_to (fatal);
text_receiver.listen_to (warning);
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+ if (g_getenv ("BOOST_DEBUG")) {
+ boost_debug_shared_ptr_show_live_debugging (true);
+ }
+#endif
+
if (parse_opts (argc, argv)) {
+ command_line_parse_error (&argc, &argv);
exit (1);
}
- if (curvetest_file) {
- return curvetest (curvetest_file);
- }
-
- cout << _("Ardour/GTK ")
+ cout << PROGRAM_NAME
<< VERSIONSTRING
- << _("\n (built using ")
- << ardour_svn_revision
+ << _(" (built using ")
+ << revision
#ifdef __GNUC__
- << _(" and GCC version ") << __VERSION__
+ << _(" and GCC version ") << __VERSION__
#endif
<< ')'
<< endl;
-
+
if (just_version) {
exit (0);
}
if (no_splash) {
- cerr << _("Copyright (C) 1999-2006 Paul Davis") << endl
- << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker") << endl
+ cerr << _("Copyright (C) 1999-2018 Paul Davis") << endl
+ << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker, Robin Gareus") << endl
<< endl
- << _("Ardour comes with ABSOLUTELY NO WARRANTY") << endl
+ << string_compose (_("%1 comes with ABSOLUTELY NO WARRANTY"), PROGRAM_NAME) << endl
<< _("not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.") << endl
<< _("This is free software, and you are welcome to redistribute it ") << endl
<< _("under certain conditions; see the source for copying conditions.")
<< endl;
}
- try {
- ui = new ARDOUR_UI (&argc, &argv, which_ui_rcfile());
- } catch (failed_constructor& err) {
- error << _("could not create ARDOUR GUI") << endmsg;
+ if (!ARDOUR::init (ARDOUR_COMMAND_LINE::use_vst, ARDOUR_COMMAND_LINE::try_hw_optimization, localedir.c_str())) {
+ error << string_compose (_("could not initialize %1."), PROGRAM_NAME) << endmsg;
+ Gtk::Main main (argc, argv);
+ Gtk::MessageDialog msg (string_compose (_("Could not initialize %1 (likely due to corrupt config files).\n"
+ "Run %1 from a commandline for more information."), PROGRAM_NAME),
+ false, Gtk::MESSAGE_ERROR , Gtk::BUTTONS_OK, true);
+ msg.run ();
exit (1);
}
- if (!keybindings_path.empty()) {
- ui->set_keybindings_path (keybindings_path);
+ if (curvetest_file) {
+ return curvetest (curvetest_file);
}
- if (!no_splash) {
- ui->show_splash ();
- if (session_name.length()) {
- g_timeout_add (4000, show_ui_callback, ui);
- }
+#ifndef PLATFORM_WINDOWS
+ if (::signal (SIGPIPE, sigpipe_handler)) {
+ cerr << _("Cannot xinstall SIGPIPE error handler") << endl;
}
+#endif
+
+ DEBUG_TRACE (DEBUG::Locale, string_compose ("main() locale '%1'\n", setlocale (LC_NUMERIC, NULL)));
- try {
- ARDOUR::init (use_vst, try_hw_optimization);
- setup_gtk_ardour_enums ();
- Config->set_current_owner (ConfigVariableBase::Interface);
-
- try {
- engine = new ARDOUR::AudioEngine (jack_client_name);
- } catch (AudioEngine::NoBackendAvailable& err) {
- gui_jack_error ();
- error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
- return -1;
- }
-
- ui->set_engine (*engine);
+ if (UIConfiguration::instance().pre_gui_init ()) {
+ error << _("Could not complete pre-GUI initialization") << endmsg;
+ exit (1);
+ }
+ try {
+ ui = new ARDOUR_UI (&argc, &argv, localedir.c_str());
} catch (failed_constructor& err) {
- error << _("could not initialize Ardour.") << endmsg;
- return -1;
- }
+ error << string_compose (_("could not create %1 GUI"), PROGRAM_NAME) << endmsg;
+ exit (1);
+ }
- ui->start_engine ();
+#ifndef NDEBUG
+ g_log_set_handler (NULL,
+ GLogLevelFlags (G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL | G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_RECURSION),
+ &ardour_g_log, NULL);
+#endif
- if (maybe_load_session ()) {
- ui->run (text_receiver);
- ui = 0;
- }
+ ui->run (text_receiver);
+ Gtkmm2ext::Application::instance()->cleanup();
+ delete ui;
+ ui = 0;
- delete engine;
ARDOUR::cleanup ();
- shutdown (0);
+#ifndef NDEBUG
+ if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
+ Glib::usleep(100000);
+ sched_yield();
+ }
+#endif
+
+ pthread_cancel_all ();
+
+#ifndef NDEBUG
+ if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
+ Glib::usleep(100000);
+ sched_yield();
+ }
+#endif
+
+ console_madness_end ();
return 0;
}
-#ifdef VST_SUPPORT
-} // end of extern C block
+#if (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
+} // end of extern "C" block
#endif
-