libs/backends/jack/jack_portengine.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 <string.h>
  21 #include <stdint.h>
  22
  23 #include "pbd/error.h"
  24
  25 #include "jack_audiobackend.h"
  26 #include "jack_connection.h"
  27
  28 #include "ardour/port_manager.h"
  29
  30 #include "i18n.h"
  31
  32 using namespace ARDOUR;
  33 using namespace PBD;
  34 using std::string;
  35 using std::vector;
  36
  37 #define GET_PRIVATE_JACK_POINTER(localvar)  jack_client_t* localvar = _jack_connection->jack(); if (!(localvar)) { return; }
  38 #define GET_PRIVATE_JACK_POINTER_RET(localvar,r) jack_client_t* localvar = _jack_connection->jack(); if (!(localvar)) { return r; }
  39
  40 static uint32_t
  41 ardour_port_flags_to_jack_flags (PortFlags flags)
  42 {
  43         uint32_t jack_flags = 0;
  44
  45         if (flags & IsInput) {
  46                 jack_flags |= JackPortIsInput;
  47         }
  48         if (flags & IsOutput) {
  49                 jack_flags |= JackPortIsOutput;
  50         }
  51         if (flags & IsTerminal) {
  52                 jack_flags |= JackPortIsTerminal;
  53         }
  54         if (flags & IsPhysical) {
  55                 jack_flags |= JackPortIsPhysical;
  56         }
  57         if (flags & CanMonitor) {
  58                 jack_flags |= JackPortCanMonitor;
  59         }
  60
  61         return jack_flags;
  62 }
  63
  64 static DataType
  65 jack_port_type_to_ardour_data_type (const char* jack_type)
  66 {
  67         if (strcmp (jack_type, JACK_DEFAULT_AUDIO_TYPE) == 0) {
  68                 return DataType::AUDIO;
  69         } else if (strcmp (jack_type, JACK_DEFAULT_MIDI_TYPE) == 0) {
  70                 return DataType::MIDI;
  71         }
  72         return DataType::NIL;
  73 }
  74
  75 static const char*
  76 ardour_data_type_to_jack_port_type (DataType d)
  77 {
  78         switch (d) {
  79         case DataType::AUDIO:
  80                 return JACK_DEFAULT_AUDIO_TYPE;
  81         case DataType::MIDI:
  82                 return JACK_DEFAULT_MIDI_TYPE;
  83         }
  84
  85         return "";
  86 }
  87
  88 void
  89 JACKAudioBackend::when_connected_to_jack ()
  90 {
  91         /* register callbacks for stuff that is our responsibility */
  92
  93         jack_client_t* client = _jack_connection->jack();
  94
  95         if (!client) {
  96                 /* how could this happen? it could ... */
  97                 error << _("Already disconnected from JACK before PortEngine could register callbacks") << endmsg;
  98                 return;
  99         }
 100
 101         jack_set_port_registration_callback (client, _registration_callback, this);
 102         jack_set_port_connect_callback (client, _connect_callback, this);
 103         jack_set_graph_order_callback (client, _graph_order_callback, this);
 104 }
 105
 106 int
 107 JACKAudioBackend::set_port_name (PortHandle port, const std::string& name)
 108 {
 109 #if HAVE_JACK_PORT_RENAME
 110         jack_client_t* client = _jack_connection->jack();
 111         if (client) {
 112                 return jack_port_rename (client, (jack_port_t*) port, name.c_str());
 113         } else {
 114                 return -1;
 115         }
 116 #else
 117         return jack_port_set_name ((jack_port_t*) port, name.c_str());
 118 #endif
 119 }
 120
 121 string
 122 JACKAudioBackend::get_port_name (PortHandle port) const
 123 {
 124         return jack_port_name ((jack_port_t*) port);
 125 }
 126
 127 int
 128 JACKAudioBackend::get_port_property (PortHandle port, const std::string& key, std::string& value, std::string& type) const
 129 {
 130 #ifdef HAVE_JACK_METADATA // really everyone ought to have this by now.
 131         int rv = -1;
 132         char *cvalue = NULL;
 133         char *ctype = NULL;
 134
 135         jack_uuid_t uuid = jack_port_uuid((jack_port_t*) port);
 136         rv = jack_get_property(uuid, key.c_str(), &cvalue, &ctype);
 137
 138         if (0 == rv) {
 139                 value = cvalue;
 140                 type = ctype;
 141                 jack_free(cvalue);
 142                 jack_free(ctype);
 143         }
 144         return rv;
 145 #else
 146         return -1;
 147 #endif
 148 }
 149
 150 PortEngine::PortHandle
 151 JACKAudioBackend:: get_port_by_name (const std::string& name) const
 152 {
 153         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, 0);
 154         return (PortHandle) jack_port_by_name (_priv_jack, name.c_str());
 155 }
 156
 157 void
 158 JACKAudioBackend::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
 159 {
 160         static_cast<JACKAudioBackend*> (arg)->manager.registration_callback ();
 161 }
 162
 163 int
 164 JACKAudioBackend::_graph_order_callback (void *arg)
 165 {
 166         return static_cast<JACKAudioBackend*> (arg)->manager.graph_order_callback ();
 167 }
 168
 169 void
 170 JACKAudioBackend::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg)
 171 {
 172         static_cast<JACKAudioBackend*> (arg)->connect_callback (id_a, id_b, conn);
 173 }
 174
 175 void
 176 JACKAudioBackend::connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn)
 177 {
 178         if (manager.port_remove_in_progress()) {
 179                 return;
 180         }
 181
 182         GET_PRIVATE_JACK_POINTER (_priv_jack);
 183
 184         jack_port_t* a = jack_port_by_id (_priv_jack, id_a);
 185         jack_port_t* b = jack_port_by_id (_priv_jack, id_b);
 186
 187         manager.connect_callback (jack_port_name (a), jack_port_name (b), conn == 0 ? false : true);
 188 }
 189
 190 bool
 191 JACKAudioBackend::connected (PortHandle port, bool process_callback_safe)
 192 {
 193         bool ret = false;
 194
 195         const char** ports;
 196
 197         if (process_callback_safe) {
 198                 ports = jack_port_get_connections ((jack_port_t*)port);
 199         } else {
 200                 GET_PRIVATE_JACK_POINTER_RET (_priv_jack, false);
 201                 ports = jack_port_get_all_connections (_priv_jack, (jack_port_t*)port);
 202         }
 203
 204         if (ports) {
 205                 ret = true;
 206         }
 207
 208         jack_free (ports);
 209
 210         return ret;
 211 }
 212
 213 bool
 214 JACKAudioBackend::connected_to (PortHandle port, const std::string& other, bool process_callback_safe)
 215 {
 216         bool ret = false;
 217         const char** ports;
 218
 219         if (process_callback_safe) {
 220                 ports = jack_port_get_connections ((jack_port_t*)port);
 221         } else {
 222                 GET_PRIVATE_JACK_POINTER_RET (_priv_jack, false);
 223                 ports = jack_port_get_all_connections (_priv_jack, (jack_port_t*)port);
 224         }
 225
 226         if (ports) {
 227                 for (int i = 0; ports[i]; ++i) {
 228                         if (other == ports[i]) {
 229                                 ret = true;
 230                         }
 231                 }
 232                 jack_free (ports);
 233         }
 234
 235         return ret;
 236 }
 237
 238 bool
 239 JACKAudioBackend::physically_connected (PortHandle p, bool process_callback_safe)
 240 {
 241         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, false);
 242         jack_port_t* port = (jack_port_t*) p;
 243
 244         const char** ports;
 245
 246         if (process_callback_safe) {
 247                 ports = jack_port_get_connections ((jack_port_t*)port);
 248         } else {
 249                 GET_PRIVATE_JACK_POINTER_RET (_priv_jack, false);
 250                 ports = jack_port_get_all_connections (_priv_jack, (jack_port_t*)port);
 251         }
 252
 253         if (ports) {
 254                 for (int i = 0; ports[i]; ++i) {
 255
 256                         jack_port_t* other = jack_port_by_name (_priv_jack, ports[i]);
 257
 258                         if (other && (jack_port_flags (other) & JackPortIsPhysical)) {
 259                                 return true;
 260                         }
 261                 }
 262                 jack_free (ports);
 263         }
 264
 265         return false;
 266 }
 267
 268 int
 269 JACKAudioBackend::get_connections (PortHandle port, vector<string>& s, bool process_callback_safe)
 270 {
 271         const char** ports;
 272
 273         if (process_callback_safe) {
 274                 ports = jack_port_get_connections ((jack_port_t*)port);
 275         } else {
 276                 GET_PRIVATE_JACK_POINTER_RET (_priv_jack, 0);
 277                 ports = jack_port_get_all_connections (_priv_jack, (jack_port_t*)port);
 278         }
 279
 280         if (ports) {
 281                 for (int i = 0; ports[i]; ++i) {
 282                         s.push_back (ports[i]);
 283                 }
 284                 jack_free (ports);
 285         }
 286
 287         return s.size();
 288 }
 289
 290 DataType
 291 JACKAudioBackend::port_data_type (PortHandle p) const
 292 {
 293         return jack_port_type_to_ardour_data_type (jack_port_type ((jack_port_t*) p));
 294 }
 295
 296 const string&
 297 JACKAudioBackend::my_name() const
 298 {
 299         return _jack_connection->client_name();
 300 }
 301
 302 bool
 303 JACKAudioBackend::port_is_physical (PortHandle ph) const
 304 {
 305         if (!ph) {
 306                 return false;
 307         }
 308
 309         return jack_port_flags ((jack_port_t*) ph) & JackPortIsPhysical;
 310 }
 311
 312 int
 313 JACKAudioBackend::get_ports (const string& port_name_pattern, DataType type, PortFlags flags, vector<string>& s) const
 314 {
 315
 316         GET_PRIVATE_JACK_POINTER_RET (_priv_jack,0);
 317
 318         const char** ports =  jack_get_ports (_priv_jack, port_name_pattern.c_str(),
 319                                               ardour_data_type_to_jack_port_type (type),
 320                                               ardour_port_flags_to_jack_flags (flags));
 321
 322         if (ports == 0) {
 323                 return 0;
 324         }
 325
 326         for (uint32_t i = 0; ports[i]; ++i) {
 327                 s.push_back (ports[i]);
 328         }
 329
 330         jack_free (ports);
 331
 332         return s.size();
 333 }
 334
 335 ChanCount
 336 JACKAudioBackend::n_physical_inputs () const
 337 {
 338         return n_physical (JackPortIsInput);
 339 }
 340
 341 ChanCount
 342 JACKAudioBackend::n_physical_outputs () const
 343 {
 344         return n_physical (JackPortIsOutput);
 345 }
 346
 347 void
 348 JACKAudioBackend::get_physical (DataType type, unsigned long flags, vector<string>& phy) const
 349 {
 350         GET_PRIVATE_JACK_POINTER (_priv_jack);
 351         const char ** ports;
 352
 353         if ((ports = jack_get_ports (_priv_jack, NULL, ardour_data_type_to_jack_port_type (type), JackPortIsPhysical | flags)) == 0) {
 354                 return;
 355         }
 356
 357         if (ports) {
 358                 for (uint32_t i = 0; ports[i]; ++i) {
 359                         if (strstr (ports[i], "Midi-Through")) {
 360                                 continue;
 361                         }
 362                         phy.push_back (ports[i]);
 363                 }
 364                 jack_free (ports);
 365         }
 366 }
 367
 368 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
 369  *  a physical input connector.
 370  */
 371 void
 372 JACKAudioBackend::get_physical_inputs (DataType type, vector<string>& ins)
 373 {
 374         get_physical (type, JackPortIsOutput, ins);
 375 }
 376
 377 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
 378  *  a physical output connector.
 379  */
 380 void
 381 JACKAudioBackend::get_physical_outputs (DataType type, vector<string>& outs)
 382 {
 383         get_physical (type, JackPortIsInput, outs);
 384 }
 385
 386
 387 bool
 388 JACKAudioBackend::can_monitor_input () const
 389 {
 390         GET_PRIVATE_JACK_POINTER_RET (_priv_jack,false);
 391         const char ** ports;
 392
 393         if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
 394                 return false;
 395         }
 396
 397         jack_free (ports);
 398
 399         return true;
 400 }
 401
 402 int
 403 JACKAudioBackend::request_input_monitoring (PortHandle port, bool yn)
 404 {
 405         return jack_port_request_monitor ((jack_port_t*) port, yn);
 406 }
 407 int
 408 JACKAudioBackend::ensure_input_monitoring (PortHandle port, bool yn)
 409 {
 410         return jack_port_ensure_monitor ((jack_port_t*) port, yn);
 411 }
 412 bool
 413 JACKAudioBackend::monitoring_input (PortHandle port)
 414 {
 415         return jack_port_monitoring_input ((jack_port_t*) port);
 416 }
 417
 418 PortEngine::PortHandle
 419 JACKAudioBackend::register_port (const std::string& shortname, ARDOUR::DataType type, ARDOUR::PortFlags flags)
 420 {
 421         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, 0);
 422         return jack_port_register (_priv_jack, shortname.c_str(),
 423                                    ardour_data_type_to_jack_port_type (type),
 424                                    ardour_port_flags_to_jack_flags (flags),
 425                                    0);
 426 }
 427
 428 void
 429 JACKAudioBackend::unregister_port (PortHandle port)
 430 {
 431         GET_PRIVATE_JACK_POINTER (_priv_jack);
 432         (void) jack_port_unregister (_priv_jack, (jack_port_t*) port);
 433 }
 434
 435 int
 436 JACKAudioBackend::connect (PortHandle port, const std::string& other)
 437 {
 438         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, -1);
 439         return jack_connect (_priv_jack, jack_port_name ((jack_port_t*) port), other.c_str());
 440 }
 441 int
 442 JACKAudioBackend::connect (const std::string& src, const std::string& dst)
 443 {
 444         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, -1);
 445
 446         int r = jack_connect (_priv_jack, src.c_str(), dst.c_str());
 447         return r;
 448 }
 449
 450 int
 451 JACKAudioBackend::disconnect (PortHandle port, const std::string& other)
 452 {
 453         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, -1);
 454         return jack_disconnect (_priv_jack, jack_port_name ((jack_port_t*) port), other.c_str());
 455 }
 456
 457 int
 458 JACKAudioBackend::disconnect (const std::string& src, const std::string& dst)
 459 {
 460         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, -1);
 461         return jack_disconnect (_priv_jack, src.c_str(), dst.c_str());
 462 }
 463
 464 int
 465 JACKAudioBackend::disconnect_all (PortHandle port)
 466 {
 467         GET_PRIVATE_JACK_POINTER_RET (_priv_jack, -1);
 468         return jack_port_disconnect (_priv_jack, (jack_port_t*) port);
 469 }
 470
 471 int
 472 JACKAudioBackend::midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index)
 473 {
 474         jack_midi_event_t ev;
 475         int ret;
 476
 477         if ((ret = jack_midi_event_get (&ev, port_buffer, event_index)) == 0) {
 478                 timestamp = ev.time;
 479                 size = ev.size;
 480                 *buf = ev.buffer;
 481         }
 482
 483         return ret;
 484 }
 485
 486 int
 487 JACKAudioBackend::midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size)
 488 {
 489         return jack_midi_event_write (port_buffer, timestamp, buffer, size);
 490 }
 491
 492 uint32_t
 493 JACKAudioBackend::get_midi_event_count (void* port_buffer)
 494 {
 495         return jack_midi_get_event_count (port_buffer);
 496 }
 497
 498 void
 499 JACKAudioBackend::midi_clear (void* port_buffer)
 500 {
 501         jack_midi_clear_buffer (port_buffer);
 502 }
 503
 504 void
 505 JACKAudioBackend::set_latency_range (PortHandle port, bool for_playback, LatencyRange r)
 506 {
 507         jack_latency_range_t range;
 508
 509         range.min = r.min;
 510         range.max = r.max;
 511
 512         jack_port_set_latency_range ((jack_port_t*) port, for_playback ? JackPlaybackLatency : JackCaptureLatency, &range);
 513 }
 514
 515 LatencyRange
 516 JACKAudioBackend::get_latency_range (PortHandle port, bool for_playback)
 517 {
 518         jack_latency_range_t range;
 519         LatencyRange ret;
 520
 521         jack_port_get_latency_range ((jack_port_t*) port, for_playback ? JackPlaybackLatency : JackCaptureLatency, &range);
 522
 523         ret.min = range.min;
 524         ret.max = range.max;
 525
 526         return ret;
 527 }
 528
 529 void*
 530 JACKAudioBackend::get_buffer (PortHandle port, pframes_t nframes)
 531 {
 532         return jack_port_get_buffer ((jack_port_t*) port, nframes);
 533 }
 534
 535 uint32_t
 536 JACKAudioBackend::port_name_size() const
 537 {
 538         return jack_port_name_size ();
 539 }