gtk2_ardour/main.cc

   1 /*
   2  * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
   3  * Copyright (C) 2005-2007 Doug McLain <doug@nostar.net>
   4  * Copyright (C) 2005-2019 Paul Davis <paul@linuxaudiosystems.com>
   5  * Copyright (C) 2006-2011 David Robillard <d@drobilla.net>
   6  * Copyright (C) 2006-2015 Tim Mayberry <mojofunk@gmail.com>
   7  * Copyright (C) 2006 Nick Mainsbridge <mainsbridge@gmail.com>
   8  * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
   9  * Copyright (C) 2008-2009 Hans Baier <hansfbaier@googlemail.com>
  10  * Copyright (C) 2013-2017 John Emmas <john@creativepost.co.uk>
  11  * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #include <cstdlib>
  29 #include <cerrno>
  30 #include <vector>
  31
  32 #include <signal.h>
  33 #include <locale.h>
  34
  35 #include <sigc++/bind.h>
  36 #include <gtkmm/settings.h>
  37
  38 #include <curl/curl.h>
  39
  40 #include "pbd/error.h"
  41 #include "pbd/file_utils.h"
  42 #include "pbd/textreceiver.h"
  43 #include "pbd/failed_constructor.h"
  44 #include "pbd/pathexpand.h"
  45 #include "pbd/pthread_utils.h"
  46 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
  47 #include "pbd/boost_debug.h"
  48 #endif
  49
  50 #include "ardour/revision.h"
  51 #include "ardour/ardour.h"
  52 #include "ardour/audioengine.h"
  53 #include "ardour/session_utils.h"
  54 #include "ardour/filesystem_paths.h"
  55
  56 #include <gtkmm/main.h>
  57 #include <gtkmm/stock.h>
  58
  59 #include <gtkmm2ext/application.h>
  60 #include <gtkmm2ext/utils.h>
  61
  62 #include "ardour_message.h"
  63 #include "ardour_ui.h"
  64 #include "ui_config.h"
  65 #include "opts.h"
  66 #include "enums.h"
  67 #include "bundle_env.h"
  68
  69 #include "pbd/i18n.h"
  70
  71 #ifdef PLATFORM_WINDOWS
  72 #include <fcntl.h> // Needed for '_fmode'
  73 #include <shellapi.h> // console
  74 #endif
  75
  76 #ifdef WAF_BUILD
  77 #include "gtk2ardour-version.h"
  78 #endif
  79
  80 #ifdef LXVST_SUPPORT
  81 #include <gdk/gdkx.h>
  82 #endif
  83
  84 using namespace std;
  85 using namespace Gtk;
  86 using namespace ARDOUR_COMMAND_LINE;
  87 using namespace ARDOUR;
  88 using namespace PBD;
  89
  90 TextReceiver text_receiver (PROGRAM_NAME);
  91
  92 extern int curvetest (string);
  93
  94 static ARDOUR_UI  *ui = 0;
  95 static string localedir (LOCALEDIR);
  96
  97 void
  98 gui_jack_error ()
  99 {
 100         ArdourMessageDialog win (string_compose (_("%1 could not connect to the audio backend."), PROGRAM_NAME),
 101                                  false,
 102                                  Gtk::MESSAGE_INFO,
 103                                  Gtk::BUTTONS_NONE);
 104
 105         win.add_button (Stock::QUIT, RESPONSE_CLOSE);
 106         win.set_default_response (RESPONSE_CLOSE);
 107
 108         win.show_all ();
 109         win.set_position (Gtk::WIN_POS_CENTER);
 110
 111         if (!no_splash) {
 112                 ui->hide_splash ();
 113         }
 114
 115         /* we just don't care about the result, but we want to block */
 116
 117         win.run ();
 118 }
 119
 120 #ifndef NDEBUG
 121 static void ardour_g_log (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data) {
 122         switch (log_level) {
 123                 case G_LOG_FLAG_FATAL:
 124                 case G_LOG_LEVEL_CRITICAL:
 125                         fatal << "g_log: " << message << endmsg;
 126                         break;
 127                 case G_LOG_LEVEL_ERROR:
 128                         error << "g_log: " << message << endmsg;
 129                         break;
 130                 case G_LOG_LEVEL_WARNING:
 131                         warning << "g_log: " << message << endmsg;
 132                         break;
 133                 case G_LOG_LEVEL_MESSAGE:
 134                 case G_LOG_LEVEL_INFO:
 135                 default:
 136                         info << "g_log: " << message << endmsg;
 137                         break;
 138         }
 139 }
 140 #endif
 141
 142 static gboolean
 143 tell_about_backend_death (void* /* ignored */)
 144 {
 145         if (AudioEngine::instance()->processed_samples() == 0) {
 146                 /* died during startup */
 147                 ArdourMessageDialog msg (string_compose (_("The audio backend (%1) has failed, or terminated"), AudioEngine::instance()->current_backend_name()), false);
 148                 msg.set_position (Gtk::WIN_POS_CENTER);
 149                 msg.set_secondary_text (string_compose (_(
 150 "%2 exited unexpectedly, and without notifying %1.\n\
 151 \n\
 152 This could be due to misconfiguration or to an error inside %2.\n\
 153 \n\
 154 Click OK to exit %1."), PROGRAM_NAME, AudioEngine::instance()->current_backend_name()));
 155
 156                 msg.run ();
 157                 _exit (EXIT_SUCCESS);
 158
 159         } else {
 160
 161                 /* engine has already run, so this is a mid-session backend death */
 162
 163                 MessageDialog msg (string_compose (_("The audio backend (%1) has failed, or terminated"), AudioEngine::instance()->current_backend_name()), false);
 164                 msg.set_secondary_text (string_compose (_("%2 exited unexpectedly, and without notifying %1."),
 165                                                          PROGRAM_NAME, AudioEngine::instance()->current_backend_name()));
 166                 msg.run ();
 167         }
 168         return false; /* do not call again */
 169 }
 170
 171 #ifndef PLATFORM_WINDOWS
 172 static void
 173 sigpipe_handler (int /*signal*/)
 174 {
 175         /* XXX fix this so that we do this again after a reconnect to the backend */
 176
 177         static bool done_the_backend_thing = false;
 178
 179         if (!done_the_backend_thing) {
 180                 AudioEngine::instance()->died ();
 181                 g_idle_add (tell_about_backend_death, 0);
 182                 done_the_backend_thing =  true;
 183         }
 184 }
 185 #endif
 186
 187 #if (!defined COMPILER_MSVC && defined PLATFORM_WINDOWS)
 188
 189 static FILE* pStdOut = 0;
 190 static FILE* pStdErr = 0;
 191 static BOOL  bConsole;
 192 static HANDLE hStdOut;
 193
 194 static bool
 195 IsAConsolePort (HANDLE handle)
 196 {
 197         DWORD mode;
 198         return (GetConsoleMode(handle, &mode) != 0);
 199 }
 200
 201 static void
 202 console_madness_begin ()
 203 {
 204         bConsole = AttachConsole(ATTACH_PARENT_PROCESS);
 205         hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
 206
 207         /* re-attach to the console so we can see 'printf()' output etc.
 208          * for MSVC see  gtk2_ardour/msvc/winmain.cc
 209          */
 210
 211         if ((bConsole) && (IsAConsolePort(hStdOut))) {
 212                 pStdOut = freopen( "CONOUT$", "w", stdout );
 213                 pStdErr = freopen( "CONOUT$", "w", stderr );
 214         }
 215 }
 216
 217 static void
 218 console_madness_end ()
 219 {
 220         if (pStdOut) {
 221                 fclose (pStdOut);
 222         }
 223         if (pStdErr) {
 224                 fclose (pStdErr);
 225         }
 226
 227         if (bConsole) {
 228                 // Detach and free the console from our application
 229                 INPUT_RECORD input_record;
 230
 231                 input_record.EventType = KEY_EVENT;
 232                 input_record.Event.KeyEvent.bKeyDown = TRUE;
 233                 input_record.Event.KeyEvent.dwControlKeyState = 0;
 234                 input_record.Event.KeyEvent.uChar.UnicodeChar = VK_RETURN;
 235                 input_record.Event.KeyEvent.wRepeatCount      = 1;
 236                 input_record.Event.KeyEvent.wVirtualKeyCode   = VK_RETURN;
 237                 input_record.Event.KeyEvent.wVirtualScanCode  = MapVirtualKey( VK_RETURN, 0 );
 238
 239                 DWORD written = 0;
 240                 WriteConsoleInput( GetStdHandle( STD_INPUT_HANDLE ), &input_record, 1, &written );
 241
 242                 FreeConsole();
 243         }
 244 }
 245
 246 static void command_line_parse_error (int *argc, char** argv[]) {}
 247
 248 #elif (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
 249
 250 // these are not used here. for MSVC see  gtk2_ardour/msvc/winmain.cc
 251 static void console_madness_begin () {}
 252 static void console_madness_end () {}
 253
 254 static void command_line_parse_error (int *argc, char** argv[]) {
 255         // Since we don't ordinarily have access to stdout and stderr with
 256         // an MSVC app, let the user know we encountered a parsing error.
 257         Gtk::Main app(argc, argv); // Calls 'gtk_init()'
 258
 259         ArdourMessageDialog dlgReportParseError (string_compose (_("\n   %1 could not understand your command line      "), PROGRAM_NAME),
 260                         false, MESSAGE_ERROR, BUTTONS_CLOSE, true);
 261         dlgReportParseError.set_title (string_compose (_("An error was encountered while launching %1"), PROGRAM_NAME));
 262         dlgReportParseError.run ();
 263 }
 264
 265 #else
 266 static void console_madness_begin () {}
 267 static void console_madness_end () {}
 268 static void command_line_parse_error (int *argc, char** argv[]) {}
 269 #endif
 270
 271 #if (defined(COMPILER_MSVC) && defined(NDEBUG) && !defined(RDC_BUILD))
 272 /*
 273  *  Release build with MSVC uses ardour_main()
 274  */
 275 int ardour_main (int argc, char *argv[])
 276
 277 #elif (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
 278
 279 // prototype for function in windows_vst_plugin_ui.cc
 280 extern int windows_vst_gui_init (int* argc, char** argv[]);
 281
 282 /* this is called from the entry point of a wine-compiled
 283    executable that is linked against gtk2_ardour built
 284    as a shared library.
 285 */
 286 extern "C" {
 287
 288 int ardour_main (int argc, char *argv[])
 289
 290 #elif defined NOMAIN
 291 int nomain (int argc, char *argv[])
 292 #else
 293 int main (int argc, char *argv[])
 294 #endif
 295 {
 296         ARDOUR::check_for_old_configuration_files();
 297
 298         /* global init is not thread safe.*/
 299         if (curl_global_init (CURL_GLOBAL_DEFAULT)) {
 300                 cerr << "curl_global_init() failed. The web is gone. We're all doomed." << endl;
 301         }
 302
 303         fixup_bundle_environment (argc, argv, localedir);
 304
 305         load_custom_fonts(); /* needs to happen before any gtk and pango init calls */
 306
 307         if (!Glib::thread_supported()) {
 308                 Glib::thread_init();
 309         }
 310
 311 #ifdef LXVST_SUPPORT
 312         XInitThreads ();
 313 #endif
 314
 315 #if ENABLE_NLS
 316         /* initialize C locale to user preference */
 317         if (ARDOUR::translations_are_enabled ()) {
 318                 setlocale (LC_ALL, "");
 319         }
 320 #endif
 321
 322         console_madness_begin();
 323
 324 #if (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
 325         /* this does some magic that is needed to make GTK and X11 client interact properly.
 326          * the platform dependent code is in windows_vst_plugin_ui.cc
 327          */
 328         windows_vst_gui_init (&argc, &argv);
 329 #endif
 330
 331 #if ENABLE_NLS
 332         cerr << "bind txt domain [" << PACKAGE << "] to " << localedir << endl;
 333
 334         (void) bindtextdomain (PACKAGE, localedir.c_str());
 335         /* our i18n translations are all in UTF-8, so make sure
 336            that even if the user locale doesn't specify UTF-8,
 337            we use that when handling them.
 338         */
 339         (void) bind_textdomain_codeset (PACKAGE,"UTF-8");
 340 #endif
 341
 342         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
 343
 344         // catch error message system signals ();
 345
 346         text_receiver.listen_to (error);
 347         text_receiver.listen_to (info);
 348         text_receiver.listen_to (fatal);
 349         text_receiver.listen_to (warning);
 350
 351 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
 352         if (g_getenv ("BOOST_DEBUG")) {
 353                 boost_debug_shared_ptr_show_live_debugging (true);
 354         }
 355 #endif
 356
 357         if (parse_opts (argc, argv)) {
 358                 command_line_parse_error (&argc, &argv);
 359                 exit (EXIT_FAILURE);
 360         }
 361
 362         {
 363                 const char *adf;
 364                 if ((adf = g_getenv ("ARDOUR_DEBUG_FLAGS"))) {
 365                         PBD::parse_debug_options (adf);
 366                 }
 367         }
 368
 369         cout << PROGRAM_NAME
 370              << VERSIONSTRING
 371              << _(" (built using ")
 372              << revision
 373 #ifdef __GNUC__
 374              << _(" and GCC version ") << __VERSION__
 375 #endif
 376              << ')'
 377              << endl;
 378
 379         if (just_version) {
 380                 exit (EXIT_SUCCESS);
 381         }
 382
 383         if (no_splash) {
 384                 cerr << _("Copyright (C) 1999-2019 Paul Davis") << endl
 385                      << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker, Robin Gareus") << endl
 386                      << endl
 387                      << string_compose (_("%1 comes with ABSOLUTELY NO WARRANTY"), PROGRAM_NAME) << endl
 388                      << _("not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.") << endl
 389                      << _("This is free software, and you are welcome to redistribute it ") << endl
 390                      << _("under certain conditions; see the source for copying conditions.")
 391                      << endl;
 392         }
 393
 394         if (!ARDOUR::init (ARDOUR_COMMAND_LINE::use_vst, ARDOUR_COMMAND_LINE::try_hw_optimization, localedir.c_str(), true)) {
 395                 error << string_compose (_("could not initialize %1."), PROGRAM_NAME) << endmsg;
 396                 Gtk::Main main (argc, argv);
 397                 Gtk::MessageDialog msg (string_compose (_("Could not initialize %1 (likely due to corrupt config files).\n"
 398                                                           "Run %1 from a commandline for more information."), PROGRAM_NAME),
 399                                         false, Gtk::MESSAGE_ERROR , Gtk::BUTTONS_OK, true);
 400                 msg.run ();
 401                 exit (EXIT_FAILURE);
 402         }
 403
 404 #ifndef PLATFORM_WINDOWS
 405         if (::signal (SIGPIPE, sigpipe_handler)) {
 406                 cerr << _("Cannot xinstall SIGPIPE error handler") << endl;
 407         }
 408 #endif
 409
 410         DEBUG_TRACE (DEBUG::Locale, string_compose ("main() locale '%1'\n", setlocale (LC_NUMERIC, NULL)));
 411
 412         if (UIConfiguration::instance().pre_gui_init ()) {
 413                 error << _("Could not complete pre-GUI initialization") << endmsg;
 414                 exit (EXIT_FAILURE);
 415         }
 416
 417         try {
 418                 ui = new ARDOUR_UI (&argc, &argv, localedir.c_str());
 419         } catch (failed_constructor& err) {
 420                 error << string_compose (_("could not create %1 GUI"), PROGRAM_NAME) << endmsg;
 421                 exit (EXIT_FAILURE);
 422         }
 423
 424 #ifndef NDEBUG
 425         g_log_set_handler (NULL,
 426                         GLogLevelFlags (G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL |  G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_RECURSION),
 427                         &ardour_g_log, NULL);
 428 #endif
 429
 430         ui->run (text_receiver);
 431         Gtkmm2ext::Application::instance()->cleanup();
 432         delete ui;
 433         ui = 0;
 434
 435         ARDOUR::cleanup ();
 436 #ifndef NDEBUG
 437         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 438                 Glib::usleep(100000);
 439                 sched_yield();
 440         }
 441 #endif
 442
 443         pthread_cancel_all ();
 444
 445 #ifndef NDEBUG
 446         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 447                 Glib::usleep(100000);
 448                 sched_yield();
 449         }
 450 #endif
 451
 452         console_madness_end ();
 453
 454         return 0;
 455 }
 456 #if (defined WINDOWS_VST_SUPPORT && !defined PLATFORM_WINDOWS)
 457 } // end of extern "C" block
 458 #endif