2 Copyright (C) 2002 Paul Davis
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.
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.
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.
25 #include <glibmm/timer.h>
26 #include <pbd/pthread_utils.h>
27 #include <pbd/stacktrace.h>
29 #include <ardour/audioengine.h>
30 #include <ardour/buffer.h>
31 #include <ardour/port.h>
32 #include <ardour/session.h>
33 #include <ardour/cycle_timer.h>
34 #include <ardour/utils.h>
39 #include <ardour/timestamps.h>
44 using namespace ARDOUR;
47 gint AudioEngine::m_meter_exit;
50 ardour_jack_error (const char* msg)
52 // throw JACK errors away - they cause visual clutter
53 // error << "JACK: " << msg << endmsg;
56 AudioEngine::AudioEngine (string client_name)
60 session_remove_pending = false;
63 last_monitor_check = 0;
64 monitor_check_interval = max_frames;
65 _processed_frames = 0;
70 _freewheel_thread_registered = false;
71 _freewheeling = false;
74 g_atomic_int_set (&m_meter_exit, 0);
76 if (connect_to_jack (client_name)) {
77 throw NoBackendAvailable ();
81 AudioEngine::~AudioEngine ()
84 Glib::Mutex::Lock tm (_process_lock);
85 session_removed.signal ();
88 jack_client_close (_jack);
91 stop_metering_thread ();
96 _thread_init_callback (void *arg)
98 /* make sure that anybody who needs to know about this thread
102 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
106 AudioEngine::start ()
111 nframes_t blocksize = jack_get_buffer_size (_jack);
113 BootMessage (_("Connect session to engine"));
115 session->set_block_size (blocksize);
116 session->set_frame_rate (jack_get_sample_rate (_jack));
118 /* page in as much of the session process code as we
119 can before we really start running.
122 session->process (blocksize);
123 session->process (blocksize);
124 session->process (blocksize);
125 session->process (blocksize);
126 session->process (blocksize);
127 session->process (blocksize);
128 session->process (blocksize);
129 session->process (blocksize);
132 _processed_frames = 0;
133 last_monitor_check = 0;
135 jack_on_shutdown (_jack, halted, this);
136 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
137 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
138 jack_set_process_callback (_jack, _process_callback, this);
139 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
140 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
141 jack_set_xrun_callback (_jack, _xrun_callback, this);
142 jack_set_sync_callback (_jack, _jack_sync_callback, this);
143 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
145 if (Config->get_jack_time_master()) {
146 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
149 if (jack_activate (_jack) == 0) {
152 Running(); /* EMIT SIGNAL */
154 // error << _("cannot activate JACK client") << endmsg;
157 start_metering_thread();
160 return _running ? 0 : -1;
164 AudioEngine::stop (bool forever)
168 stop_metering_thread ();
170 jack_client_t* foo = _jack;
172 jack_client_close (foo);
174 jack_deactivate (_jack);
176 Stopped(); /* EMIT SIGNAL */
179 return _running ? -1 : 0;
184 AudioEngine::get_sync_offset (nframes_t& offset) const
187 #ifdef HAVE_JACK_VIDEO_SUPPORT
191 (void) jack_transport_query (_jack, &pos);
193 if (pos.valid & JackVideoFrameOffset) {
194 offset = pos.video_offset;
204 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
205 jack_position_t* pos, int new_position, void *arg)
207 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
211 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
212 jack_position_t* pos, int new_position)
214 if (_jack && session && session->synced_to_jack()) {
215 session->jack_timebase_callback (state, nframes, pos, new_position);
220 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
222 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
226 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
228 if (_jack && session) {
229 return session->jack_sync_callback (state, pos);
236 AudioEngine::_xrun_callback (void *arg)
238 AudioEngine* ae = static_cast<AudioEngine*> (arg);
240 ae->Xrun (); /* EMIT SIGNAL */
246 AudioEngine::_graph_order_callback (void *arg)
248 AudioEngine* ae = static_cast<AudioEngine*> (arg);
250 ae->GraphReordered (); /* EMIT SIGNAL */
256 AudioEngine::_process_callback (nframes_t nframes, void *arg)
258 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
262 AudioEngine::_freewheel_callback (int onoff, void *arg)
264 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
268 AudioEngine::process_callback (nframes_t nframes)
270 // CycleTimer ct ("AudioEngine::process");
271 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
272 nframes_t next_processed_frames;
274 /* handle wrap around of total frames counter */
276 if (max_frames - _processed_frames < nframes) {
277 next_processed_frames = nframes - (max_frames - _processed_frames);
279 next_processed_frames = _processed_frames + nframes;
282 if (!tm.locked() || session == 0) {
283 _processed_frames = next_processed_frames;
287 if (session_remove_pending) {
289 session_remove_pending = false;
290 session_removed.signal();
291 _processed_frames = next_processed_frames;
296 if (Freewheel (nframes)) {
297 jack_set_freewheel (_jack, false);
302 session->process (nframes);
305 /* we were zombified, maybe because a ladspa plugin took
306 too long, or jackd exited, or something like that.
309 _processed_frames = next_processed_frames;
313 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
315 boost::shared_ptr<Ports> p = ports.reader();
317 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
322 if (port->_last_monitor != (x = port->monitoring_input ())) {
323 port->_last_monitor = x;
324 /* XXX I think this is dangerous, due to
325 a likely mutex in the signal handlers ...
327 port->MonitorInputChanged (x); /* EMIT SIGNAL */
330 last_monitor_check = next_processed_frames;
333 if (session->silent()) {
335 boost::shared_ptr<Ports> p = ports.reader();
337 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
341 if (port->sends_output()) {
342 Sample *buf = port->get_buffer(nframes);
343 memset (buf, 0, sizeof(Sample) * nframes);
344 // this should work but doesn't
345 //port->silence(0, nframes); //need to implement declicking fade
350 _processed_frames = next_processed_frames;
355 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
357 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
361 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
363 _frame_rate = nframes;
364 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
366 /* check for monitor input change every 1/10th of second */
368 monitor_check_interval = nframes / 10;
369 last_monitor_check = 0;
372 session->set_frame_rate (nframes);
375 SampleRateChanged (nframes); /* EMIT SIGNAL */
381 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
383 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
387 AudioEngine::jack_bufsize_callback (nframes_t nframes)
389 _buffer_size = nframes;
390 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
391 last_monitor_check = 0;
393 boost::shared_ptr<Ports> p = ports.reader();
395 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
400 session->set_block_size (_buffer_size);
407 AudioEngine::stop_metering_thread ()
409 if (m_meter_thread) {
410 g_atomic_int_set (&m_meter_exit, 1);
411 m_meter_thread->join ();
417 AudioEngine::start_metering_thread ()
419 if (m_meter_thread == 0) {
420 g_atomic_int_set (&m_meter_exit, 0);
421 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread),
422 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
427 AudioEngine::meter_thread ()
430 Glib::usleep (10000); /* 1/100th sec interval */
431 if (g_atomic_int_get(&m_meter_exit)) {
434 IO::update_meters ();
439 AudioEngine::set_session (Session *s)
441 Glib::Mutex::Lock pl (_process_lock);
447 nframes_t blocksize = jack_get_buffer_size (_jack);
449 /* page in as much of the session process code as we
450 can before we really start running.
453 session->process (blocksize);
454 session->process (blocksize);
455 session->process (blocksize);
456 session->process (blocksize);
457 session->process (blocksize);
458 session->process (blocksize);
459 session->process (blocksize);
460 session->process (blocksize);
465 AudioEngine::remove_session ()
467 Glib::Mutex::Lock lm (_process_lock);
472 session_remove_pending = true;
473 session_removed.wait(_process_lock);
484 AudioEngine::port_registration_failure (const std::string& portname)
486 string full_portname = jack_client_name;
487 full_portname += ':';
488 full_portname += portname;
491 jack_port_t* p = jack_port_by_name (_jack, full_portname.c_str());
495 reason = _("a port with this name already exists: check for duplicated track/bus names");
497 reason = _("unknown error");
500 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
504 AudioEngine::register_input_port (DataType type, const string& portname)
508 fatal << _("register input port called before engine was started") << endmsg;
515 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
521 if ((newport = new Port (p)) != 0) {
522 RCUWriter<Ports> writer (ports);
523 boost::shared_ptr<Ports> ps = writer.get_copy ();
524 ps->insert (ps->begin(), newport);
525 /* writer goes out of scope, forces update */
531 port_registration_failure (portname);
538 AudioEngine::register_output_port (DataType type, const string& portname)
542 fatal << _("register output port called before engine was started") << endmsg;
551 if ((p = jack_port_register (_jack, portname.c_str(),
552 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
557 RCUWriter<Ports> writer (ports);
558 boost::shared_ptr<Ports> ps = writer.get_copy ();
560 newport = new Port (p);
561 ps->insert (ps->begin(), newport);
563 /* writer goes out of scope, forces update */
569 port_registration_failure (portname);
577 AudioEngine::unregister_port (Port *port)
580 /* probably happening when the engine has been halted by JACK,
581 in which case, there is nothing we can do here.
588 int ret = jack_port_unregister (_jack, port->_port);
594 RCUWriter<Ports> writer (ports);
595 boost::shared_ptr<Ports> ps = writer.get_copy ();
597 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
604 /* writer goes out of scope, forces update */
607 remove_connections_for (port);
618 AudioEngine::connect (const string& source, const string& destination)
622 fatal << _("connect called before engine was started") << endmsg;
629 string s = make_port_name_non_relative (source);
630 string d = make_port_name_non_relative (destination);
632 int ret = jack_connect (_jack, s.c_str(), d.c_str());
635 pair<string,string> c (s, d);
636 port_connections.push_back (c);
637 } else if (ret == EEXIST) {
638 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
639 source, s, destination, d)
642 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
643 source, s, destination, d)
651 AudioEngine::disconnect (const string& source, const string& destination)
655 fatal << _("disconnect called before engine was started") << endmsg;
662 string s = make_port_name_non_relative (source);
663 string d = make_port_name_non_relative (destination);
665 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
668 pair<string,string> c (s, d);
669 PortConnections::iterator i;
671 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
672 port_connections.erase (i);
680 AudioEngine::disconnect (Port *port)
684 fatal << _("disconnect called before engine was started") << endmsg;
691 int ret = jack_port_disconnect (_jack, port->_port);
694 remove_connections_for (port);
702 AudioEngine::frame_rate ()
705 if (_frame_rate == 0) {
706 return (_frame_rate = jack_get_sample_rate (_jack));
711 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
719 AudioEngine::frames_per_cycle ()
722 if (_buffer_size == 0) {
723 return (_buffer_size = jack_get_buffer_size (_jack));
728 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
736 AudioEngine::get_port_by_name (const string& portname, bool keep)
738 Glib::Mutex::Lock lm (_process_lock);
742 fatal << _("get_port_by_name() called before engine was started") << endmsg;
749 /* check to see if we have a Port for this name already */
751 boost::shared_ptr<Ports> pr = ports.reader();
753 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
754 if (portname == (*i)->name()) {
761 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
762 Port *newport = new Port (p);
765 if (keep && newport->is_mine (_jack)) {
766 RCUWriter<Ports> writer (ports);
767 boost::shared_ptr<Ports> ps = writer.get_copy ();
768 ps->insert (newport);
769 /* writer goes out of scope, forces update */
782 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
786 fatal << _("get_ports called before engine was started") << endmsg;
792 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
796 AudioEngine::halted (void *arg)
798 AudioEngine* ae = static_cast<AudioEngine *> (arg);
799 bool was_running = ae->_running;
801 ae->stop_metering_thread ();
803 ae->_running = false;
804 ae->_buffer_size = 0;
809 ae->Halted(); /* EMIT SIGNAL */
814 AudioEngine::can_request_hardware_monitoring ()
822 if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
833 AudioEngine::n_physical_audio_outputs () const
842 if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsInput)) == 0) {
846 for (i = 0; ports[i]; ++i);
853 AudioEngine::n_physical_audio_inputs () const
862 if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsOutput)) == 0) {
867 for (i = 0; ports[i]; ++i);
874 AudioEngine::get_physical_audio_inputs (vector<string>& ins)
883 if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsOutput)) == 0) {
888 for (i = 0; ports[i]; ++i) {
889 ins.push_back (ports[i]);
896 AudioEngine::get_physical_audio_outputs (vector<string>& outs)
905 if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsInput)) == 0) {
910 for (i = 0; ports[i]; ++i) {
911 outs.push_back (ports[i]);
918 AudioEngine::get_nth_physical_audio (uint32_t n, int flag)
924 if (!_running || !_jack) {
926 fatal << _("get_nth_physical called before engine was started") << endmsg;
933 ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|flag);
939 for (i = 0; i < n && ports[i]; ++i);
945 free ((char *) ports);
951 AudioEngine::get_port_total_latency (const Port& port)
954 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
960 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
965 return jack_port_get_total_latency (_jack, port._port);
969 AudioEngine::transport_stop ()
971 // cerr << "tell JACK to stop\n";
973 jack_transport_stop (_jack);
978 AudioEngine::transport_start ()
980 // cerr << "tell JACK to start\n";
982 jack_transport_start (_jack);
987 AudioEngine::transport_locate (nframes_t where)
989 // cerr << "tell JACK to locate to " << where << endl;
991 jack_transport_locate (_jack, where);
995 AudioEngine::TransportState
996 AudioEngine::transport_state ()
1000 return (TransportState) jack_transport_query (_jack, &pos);
1002 return (TransportState) JackTransportStopped;
1007 AudioEngine::reset_timebase ()
1010 if (Config->get_jack_time_master()) {
1011 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1013 return jack_release_timebase (_jack);
1021 AudioEngine::freewheel (bool onoff)
1025 if (onoff != _freewheeling) {
1028 _freewheel_thread_registered = false;
1031 return jack_set_freewheel (_jack, onoff);
1034 /* already doing what has been asked for */
1044 AudioEngine::remove_all_ports ()
1046 /* process lock MUST be held */
1049 boost::shared_ptr<Ports> p = ports.reader();
1051 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1052 jack_port_unregister (_jack, (*i)->_port);
1057 RCUWriter<Ports> writer (ports);
1058 boost::shared_ptr<Ports> ps = writer.get_copy ();
1062 port_connections.clear ();
1066 AudioEngine::remove_connections_for (Port* port)
1068 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1069 PortConnections::iterator tmp;
1074 if ((*i).first == port->name()) {
1075 port_connections.erase (i);
1082 #ifdef HAVE_JACK_CLIENT_OPEN
1085 AudioEngine::connect_to_jack (string client_name)
1087 jack_options_t options = JackNullOption;
1088 jack_status_t status;
1089 const char *server_name = NULL;
1091 jack_client_name = client_name; /* might be reset below */
1092 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1094 if (_jack == NULL) {
1095 /* just return without an error message. something else will take care of it */
1099 if (status & JackNameNotUnique) {
1100 jack_client_name = jack_get_client_name (_jack);
1103 jack_set_error_function (ardour_jack_error);
1111 AudioEngine::connect_to_jack (string client_name)
1113 jack_client_name = client_name;
1115 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1122 #endif /* HAVE_JACK_CLIENT_OPEN */
1125 AudioEngine::disconnect_from_jack ()
1131 jack_client_close (_jack);
1137 stop_metering_thread ();
1139 Stopped(); /* EMIT SIGNAL */
1147 AudioEngine::reconnect_to_jack ()
1150 disconnect_from_jack ();
1151 /* XXX give jackd a chance */
1152 Glib::usleep (250000);
1155 if (connect_to_jack (jack_client_name)) {
1156 error << _("failed to connect to JACK") << endmsg;
1162 boost::shared_ptr<Ports> p = ports.reader ();
1164 for (i = p->begin(); i != p->end(); ++i) {
1166 /* XXX hack hack hack */
1168 string long_name = (*i)->name();
1171 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1173 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
1174 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1181 if ((*i)->flags() & JackPortIsOutput) {
1182 (*i)->silence (jack_get_buffer_size (_jack), 0);
1186 if (i != p->end()) {
1188 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1189 jack_port_unregister (_jack, (*i)->_port);
1196 session->reset_jack_connection (_jack);
1197 nframes_t blocksize = jack_get_buffer_size (_jack);
1198 session->set_block_size (blocksize);
1199 session->set_frame_rate (jack_get_sample_rate (_jack));
1202 last_monitor_check = 0;
1204 jack_on_shutdown (_jack, halted, this);
1205 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1206 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1207 jack_set_process_callback (_jack, _process_callback, this);
1208 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1209 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1210 jack_set_xrun_callback (_jack, _xrun_callback, this);
1211 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1212 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1214 if (Config->get_jack_time_master()) {
1215 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1218 if (jack_activate (_jack) == 0) {
1225 /* re-establish connections */
1227 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1230 jack_client_t* j = _jack;
1232 /* JACK could have zombified us. */
1235 error << _("Disconnected from JACK while reconnecting. You should quit Ardour now.") << endmsg;
1239 if ((err = jack_connect (j, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1240 if (err != EEXIST) {
1241 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1242 (*i).first, (*i).second, err)
1248 Running (); /* EMIT SIGNAL*/
1250 start_metering_thread ();
1256 AudioEngine::request_buffer_size (nframes_t nframes)
1260 if (nframes == jack_get_buffer_size (_jack)) {
1264 return jack_set_buffer_size (_jack, nframes);
1272 AudioEngine::update_total_latencies ()
1274 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1275 jack_recompute_total_latencies (_jack);
1280 AudioEngine::make_port_name_relative (string portname)
1282 string::size_type len;
1283 string::size_type n;
1285 len = portname.length();
1287 for (n = 0; n < len; ++n) {
1288 if (portname[n] == ':') {
1293 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1294 return portname.substr (n+1);
1301 AudioEngine::make_port_name_non_relative (string portname)
1305 if (portname.find_first_of (':') != string::npos) {
1309 str = jack_client_name;
1317 AudioEngine::is_realtime () const
1320 return jack_is_realtime (_jack);