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.
24 #include <glibmm/timer.h>
25 #include <pbd/pthread_utils.h>
26 #include <pbd/stacktrace.h>
28 #include <ardour/audioengine.h>
29 #include <ardour/buffer.h>
30 #include <ardour/port.h>
31 #include <ardour/session.h>
32 #include <ardour/cycle_timer.h>
33 #include <ardour/utils.h>
38 #include <ardour/timestamps.h>
43 using namespace ARDOUR;
46 gint AudioEngine::m_meter_exit;
49 ardour_jack_error (const char* msg)
51 error << "JACK: " << msg << endmsg;
54 AudioEngine::AudioEngine (string client_name)
58 session_remove_pending = false;
61 last_monitor_check = 0;
62 monitor_check_interval = max_frames;
63 _processed_frames = 0;
64 _freewheeling = false;
69 _freewheeling = false;
70 _freewheel_thread_registered = false;
73 g_atomic_int_set (&m_meter_exit, 0);
75 if (connect_to_jack (client_name)) {
76 throw NoBackendAvailable ();
79 start_metering_thread();
83 AudioEngine::~AudioEngine ()
86 Glib::Mutex::Lock tm (_process_lock);
87 session_removed.signal ();
90 jack_client_close (_jack);
93 stop_metering_thread ();
98 _thread_init_callback (void *arg)
100 /* make sure that anybody who needs to know about this thread
104 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
108 AudioEngine::start ()
113 nframes_t blocksize = jack_get_buffer_size (_jack);
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;
158 return _running ? 0 : -1;
162 AudioEngine::stop (bool forever)
167 jack_client_t* foo = _jack;
169 jack_client_close (foo);
170 stop_metering_thread ();
172 jack_deactivate (_jack);
174 Stopped(); /* EMIT SIGNAL */
177 return _running ? -1 : 0;
182 AudioEngine::get_sync_offset (nframes_t& offset) const
185 #ifdef HAVE_JACK_VIDEO_SUPPORT
189 (void) jack_transport_query (_jack, &pos);
191 if (pos.valid & JackVideoFrameOffset) {
192 offset = pos.video_offset;
202 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
203 jack_position_t* pos, int new_position, void *arg)
205 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
209 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
210 jack_position_t* pos, int new_position)
212 if (_jack && session && session->synced_to_jack()) {
213 session->jack_timebase_callback (state, nframes, pos, new_position);
218 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
220 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
224 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
226 if (_jack && session) {
227 return session->jack_sync_callback (state, pos);
234 AudioEngine::_xrun_callback (void *arg)
236 AudioEngine* ae = static_cast<AudioEngine*> (arg);
238 ae->Xrun (); /* EMIT SIGNAL */
244 AudioEngine::_graph_order_callback (void *arg)
246 AudioEngine* ae = static_cast<AudioEngine*> (arg);
248 ae->GraphReordered (); /* EMIT SIGNAL */
254 AudioEngine::_process_callback (nframes_t nframes, void *arg)
256 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
260 AudioEngine::_freewheel_callback (int onoff, void *arg)
262 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
266 AudioEngine::process_callback (nframes_t nframes)
268 // CycleTimer ct ("AudioEngine::process");
269 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
270 nframes_t next_processed_frames;
272 /* handle wrap around of total frames counter */
274 if (max_frames - _processed_frames < nframes) {
275 next_processed_frames = nframes - (max_frames - _processed_frames);
277 next_processed_frames = _processed_frames + nframes;
280 if (!tm.locked() || session == 0) {
281 _processed_frames = next_processed_frames;
285 if (session_remove_pending) {
286 cerr << "engine notes session remove pending\n";
288 session_remove_pending = false;
289 session_removed.signal();
290 cerr << "done, woken waiter\n";
291 _processed_frames = next_processed_frames;
296 if (Freewheel (nframes)) {
297 cerr << "Freewheeling returned non-zero!\n";
298 _freewheeling = false;
299 jack_set_freewheel (_jack, false);
304 session->process (nframes);
307 /* we were zombified, maybe because a ladspa plugin took
308 too long, or jackd exited, or something like that.
311 _processed_frames = next_processed_frames;
315 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
317 boost::shared_ptr<Ports> p = ports.reader();
319 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
324 if (port->_last_monitor != (x = port->monitoring_input ())) {
325 port->_last_monitor = x;
326 /* XXX I think this is dangerous, due to
327 a likely mutex in the signal handlers ...
329 port->MonitorInputChanged (x); /* EMIT SIGNAL */
332 last_monitor_check = next_processed_frames;
335 _processed_frames = next_processed_frames;
340 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
342 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
346 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
348 _frame_rate = nframes;
349 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
351 /* check for monitor input change every 1/10th of second */
353 monitor_check_interval = nframes / 10;
354 last_monitor_check = 0;
357 session->set_frame_rate (nframes);
360 SampleRateChanged (nframes); /* EMIT SIGNAL */
366 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
368 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
372 AudioEngine::jack_bufsize_callback (nframes_t nframes)
374 _buffer_size = nframes;
375 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
376 last_monitor_check = 0;
378 boost::shared_ptr<Ports> p = ports.reader();
380 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
385 session->set_block_size (_buffer_size);
392 AudioEngine::stop_metering_thread ()
394 if (m_meter_thread) {
395 g_atomic_int_set (&m_meter_exit, 1);
396 m_meter_thread->join ();
402 AudioEngine::start_metering_thread ()
404 if (m_meter_thread == 0) {
405 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread),
406 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
411 AudioEngine::meter_thread ()
414 Glib::usleep (10000); /* 1/100th sec interval */
415 if (g_atomic_int_get(&m_meter_exit)) {
418 IO::update_meters ();
423 AudioEngine::set_session (Session *s)
425 Glib::Mutex::Lock pl (_process_lock);
431 nframes_t blocksize = jack_get_buffer_size (_jack);
433 /* page in as much of the session process code as we
434 can before we really start running.
437 session->process (blocksize);
438 session->process (blocksize);
439 session->process (blocksize);
440 session->process (blocksize);
441 session->process (blocksize);
442 session->process (blocksize);
443 session->process (blocksize);
444 session->process (blocksize);
449 AudioEngine::remove_session ()
451 Glib::Mutex::Lock lm (_process_lock);
456 cerr << "mark session for removal\n";
457 session_remove_pending = true;
458 session_removed.wait(_process_lock);
470 AudioEngine::register_input_port (DataType type, const string& portname)
474 fatal << _("register input port called before engine was started") << endmsg;
481 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
487 if ((newport = new Port (p)) != 0) {
488 RCUWriter<Ports> writer (ports);
489 boost::shared_ptr<Ports> ps = writer.get_copy ();
490 ps->insert (ps->begin(), newport);
491 /* writer goes out of scope, forces update */
497 throw PortRegistrationFailure();
504 AudioEngine::register_output_port (DataType type, const string& portname)
508 fatal << _("register output port called before engine was started") << endmsg;
517 if ((p = jack_port_register (_jack, portname.c_str(),
518 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
523 RCUWriter<Ports> writer (ports);
524 boost::shared_ptr<Ports> ps = writer.get_copy ();
526 newport = new Port (p);
527 ps->insert (ps->begin(), newport);
529 /* writer goes out of scope, forces update */
535 throw PortRegistrationFailure ();
543 AudioEngine::unregister_port (Port *port)
546 /* probably happening when the engine has been halted by JACK,
547 in which case, there is nothing we can do here.
554 int ret = jack_port_unregister (_jack, port->_port);
560 RCUWriter<Ports> writer (ports);
561 boost::shared_ptr<Ports> ps = writer.get_copy ();
563 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
570 /* writer goes out of scope, forces update */
573 remove_connections_for (port);
584 AudioEngine::connect (const string& source, const string& destination)
588 fatal << _("connect called before engine was started") << endmsg;
595 string s = make_port_name_non_relative (source);
596 string d = make_port_name_non_relative (destination);
598 int ret = jack_connect (_jack, s.c_str(), d.c_str());
601 pair<string,string> c (s, d);
602 port_connections.push_back (c);
603 } else if (ret == EEXIST) {
604 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
605 source, s, destination, d)
608 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
609 source, s, destination, d)
617 AudioEngine::disconnect (const string& source, const string& destination)
621 fatal << _("disconnect called before engine was started") << endmsg;
628 string s = make_port_name_non_relative (source);
629 string d = make_port_name_non_relative (destination);
631 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
634 pair<string,string> c (s, d);
635 PortConnections::iterator i;
637 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
638 port_connections.erase (i);
646 AudioEngine::disconnect (Port *port)
650 fatal << _("disconnect called before engine was started") << endmsg;
657 int ret = jack_port_disconnect (_jack, port->_port);
660 remove_connections_for (port);
668 AudioEngine::frame_rate ()
671 if (_frame_rate == 0) {
672 return (_frame_rate = jack_get_sample_rate (_jack));
677 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
685 AudioEngine::frames_per_cycle ()
688 if (_buffer_size == 0) {
689 return (_buffer_size = jack_get_buffer_size (_jack));
694 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
702 AudioEngine::get_port_by_name (const string& portname, bool keep)
704 Glib::Mutex::Lock lm (_process_lock);
708 fatal << _("get_port_by_name() called before engine was started") << endmsg;
715 /* check to see if we have a Port for this name already */
717 boost::shared_ptr<Ports> pr = ports.reader();
719 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
720 if (portname == (*i)->name()) {
727 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
728 Port *newport = new Port (p);
731 if (keep && newport->is_mine (_jack)) {
732 RCUWriter<Ports> writer (ports);
733 boost::shared_ptr<Ports> ps = writer.get_copy ();
734 ps->insert (newport);
735 /* writer goes out of scope, forces update */
748 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
752 fatal << _("get_ports called before engine was started") << endmsg;
758 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
762 AudioEngine::halted (void *arg)
764 AudioEngine* ae = static_cast<AudioEngine *> (arg);
766 ae->_running = false;
767 ae->_buffer_size = 0;
770 ae->Halted(); /* EMIT SIGNAL */
774 AudioEngine::n_physical_outputs () const
783 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
788 for (i = 0; ports[i]; ++i);
795 AudioEngine::n_physical_inputs () const
804 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
809 for (i = 0; ports[i]; ++i);
816 AudioEngine::get_physical_inputs (vector<string>& ins)
825 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
830 for (i = 0; ports[i]; ++i) {
831 ins.push_back (ports[i]);
838 AudioEngine::get_physical_outputs (vector<string>& outs)
847 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
852 for (i = 0; ports[i]; ++i) {
853 outs.push_back (ports[i]);
860 AudioEngine::get_nth_physical (uint32_t n, int flag)
866 if (!_running || !_jack) {
868 fatal << _("get_nth_physical called before engine was started") << endmsg;
875 ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|flag);
881 for (i = 0; i < n && ports[i]; ++i);
887 free ((char *) ports);
893 AudioEngine::get_port_total_latency (const Port& port)
896 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
902 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
907 return jack_port_get_total_latency (_jack, port._port);
911 AudioEngine::transport_stop ()
913 // cerr << "tell JACK to stop\n";
915 jack_transport_stop (_jack);
920 AudioEngine::transport_start ()
922 // cerr << "tell JACK to start\n";
924 jack_transport_start (_jack);
929 AudioEngine::transport_locate (nframes_t where)
931 // cerr << "tell JACK to locate to " << where << endl;
933 jack_transport_locate (_jack, where);
937 AudioEngine::TransportState
938 AudioEngine::transport_state ()
942 return (TransportState) jack_transport_query (_jack, &pos);
944 return (TransportState) JackTransportStopped;
949 AudioEngine::reset_timebase ()
952 if (Config->get_jack_time_master()) {
953 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
955 return jack_release_timebase (_jack);
963 AudioEngine::freewheel (bool onoff)
968 _freewheel_thread_registered = false;
971 return jack_set_freewheel (_jack, onoff);
979 AudioEngine::remove_all_ports ()
981 /* process lock MUST be held */
984 boost::shared_ptr<Ports> p = ports.reader();
986 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
987 jack_port_unregister (_jack, (*i)->_port);
992 RCUWriter<Ports> writer (ports);
993 boost::shared_ptr<Ports> ps = writer.get_copy ();
997 port_connections.clear ();
1001 AudioEngine::remove_connections_for (Port* port)
1003 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1004 PortConnections::iterator tmp;
1009 if ((*i).first == port->name()) {
1010 port_connections.erase (i);
1017 #ifdef HAVE_JACK_CLIENT_OPEN
1020 AudioEngine::connect_to_jack (string client_name)
1022 jack_options_t options = JackNullOption;
1023 jack_status_t status;
1024 const char *server_name = NULL;
1026 jack_client_name = client_name; /* might be reset below */
1028 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1030 if (_jack == NULL) {
1032 if (status & JackServerFailed) {
1033 error << _("Unable to connect to JACK server") << endmsg;
1036 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
1040 if (status & JackServerStarted) {
1041 info << _("JACK server started") << endmsg;
1044 if (status & JackNameNotUnique) {
1045 jack_client_name = jack_get_client_name (_jack);
1048 jack_set_error_function (ardour_jack_error);
1056 AudioEngine::connect_to_jack (string client_name)
1058 jack_client_name = client_name;
1060 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1067 #endif /* HAVE_JACK_CLIENT_OPEN */
1070 AudioEngine::disconnect_from_jack ()
1076 jack_client_close (_jack);
1083 Stopped(); /* EMIT SIGNAL */
1091 AudioEngine::reconnect_to_jack ()
1094 disconnect_from_jack ();
1095 /* XXX give jackd a chance */
1096 Glib::usleep (250000);
1099 if (connect_to_jack (jack_client_name)) {
1100 error << _("failed to connect to JACK") << endmsg;
1106 boost::shared_ptr<Ports> p = ports.reader ();
1108 for (i = p->begin(); i != p->end(); ++i) {
1110 /* XXX hack hack hack */
1112 string long_name = (*i)->name();
1115 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1117 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
1118 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1125 if ((*i)->flags() & JackPortIsOutput) {
1126 (*i)->silence (jack_get_buffer_size (_jack), 0);
1130 if (i != p->end()) {
1132 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1133 jack_port_unregister (_jack, (*i)->_port);
1140 nframes_t blocksize = jack_get_buffer_size (_jack);
1141 session->set_block_size (blocksize);
1142 session->set_frame_rate (jack_get_sample_rate (_jack));
1145 last_monitor_check = 0;
1147 jack_on_shutdown (_jack, halted, this);
1148 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1149 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1150 jack_set_process_callback (_jack, _process_callback, this);
1151 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1152 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1153 jack_set_xrun_callback (_jack, _xrun_callback, this);
1154 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1155 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1157 if (Config->get_jack_time_master()) {
1158 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1161 if (jack_activate (_jack) == 0) {
1168 /* re-establish connections */
1170 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1174 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1175 if (err != EEXIST) {
1176 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1177 (*i).first, (*i).second, err)
1183 Running (); /* EMIT SIGNAL*/
1189 AudioEngine::request_buffer_size (nframes_t nframes)
1193 if (nframes == jack_get_buffer_size (_jack)) {
1197 return jack_set_buffer_size (_jack, nframes);
1205 AudioEngine::update_total_latencies ()
1207 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1208 jack_recompute_total_latencies (_jack);
1213 AudioEngine::make_port_name_relative (string portname)
1215 string::size_type len;
1216 string::size_type n;
1218 len = portname.length();
1220 for (n = 0; n < len; ++n) {
1221 if (portname[n] == ':') {
1226 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1227 return portname.substr (n+1);
1234 AudioEngine::make_port_name_non_relative (string portname)
1238 if (portname.find_first_of (':') != string::npos) {
1242 str = jack_client_name;
1250 AudioEngine::is_realtime () const
1253 return jack_is_realtime (_jack);