libs/backends/jack/jack_connection.cc

   1 /*
   2     Copyright (C) 2013 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <boost/scoped_ptr.hpp>
  21 #include <jack/session.h>
  22
  23 #include "pbd/epa.h"
  24
  25 #include "jack_connection.h"
  26 #include "jack_utils.h"
  27
  28 #define GET_PRIVATE_JACK_POINTER(j)  jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; }
  29 #define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; }
  30
  31 using namespace ARDOUR;
  32 using namespace PBD;
  33 using std::string;
  34 using std::vector;
  35
  36 static void jack_halted_callback (void* arg)
  37 {
  38         JackConnection* jc = static_cast<JackConnection*> (arg);
  39         jc->halted_callback ();
  40 }
  41
  42 static void jack_halted_info_callback (jack_status_t code, const char* reason, void* arg)
  43 {
  44         JackConnection* jc = static_cast<JackConnection*> (arg);
  45         jc->halted_info_callback (code, reason);
  46 }
  47
  48
  49 JackConnection::JackConnection (const std::string& arg1, const std::string& arg2)
  50         : _jack (0)
  51         , _client_name (arg1)
  52         , session_uuid (arg2)
  53 {
  54 }
  55
  56 JackConnection::~JackConnection ()
  57 {
  58         close ();
  59 }
  60
  61 bool
  62 JackConnection::server_running ()
  63 {
  64         EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
  65         boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
  66
  67         /* revert all environment settings back to whatever they were when
  68          * ardour started, because ardour's startup script may have reset
  69          * something in ways that interfere with finding/starting JACK.
  70          */
  71
  72         if (global_epa) {
  73                 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
  74                 global_epa->restore ();
  75         }
  76
  77         jack_status_t status;
  78         jack_client_t* c = jack_client_open ("ardourprobe", JackNoStartServer, &status);
  79
  80         if (status == 0) {
  81                 jack_client_close (c);
  82                 return true;
  83         }
  84
  85         return false;
  86 }
  87
  88 int
  89 JackConnection::open ()
  90 {
  91         EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
  92         boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
  93         jack_status_t status;
  94
  95         close ();
  96
  97         /* revert all environment settings back to whatever they were when ardour started
  98          */
  99
 100         if (global_epa) {
 101                 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
 102                 global_epa->restore ();
 103         }
 104
 105         /* ensure that PATH or equivalent includes likely locations of the JACK
 106          * server, in case the user's default does not.
 107          */
 108
 109         vector<string> dirs;
 110         get_jack_server_dir_paths (dirs);
 111         set_path_env_for_jack_autostart (dirs);
 112
 113         if ((_jack = jack_client_open (_client_name.c_str(), JackSessionID, &status, session_uuid.c_str())) == 0) {
 114                 return -1;
 115         }
 116
 117         if (status & JackNameNotUnique) {
 118                 _client_name = jack_get_client_name (_jack);
 119         }
 120
 121         /* attach halted handler */
 122
 123         if (jack_on_info_shutdown) {
 124                 jack_on_info_shutdown (_jack, jack_halted_info_callback, this);
 125         } else {
 126                 jack_on_shutdown (_jack, jack_halted_callback, this);
 127         }
 128
 129
 130         Connected(); /* EMIT SIGNAL */
 131
 132         return 0;
 133 }
 134
 135 int
 136 JackConnection::close ()
 137 {
 138         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
 139
 140         if (_priv_jack) {
 141                 int ret = jack_client_close (_priv_jack);
 142                 _jack = 0;
 143                 Disconnected (""); /* EMIT SIGNAL */
 144                 return ret;
 145         }
 146
 147         return 0;
 148 }
 149
 150 void
 151 JackConnection::halted_callback ()
 152 {
 153         _jack = 0;
 154         Disconnected ("");
 155 }
 156
 157 void
 158 JackConnection::halted_info_callback (jack_status_t /*status*/, const char* reason)
 159 {
 160         _jack = 0;
 161         Disconnected (reason);
 162 }
 163
 164