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>
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;
48 AudioEngine::AudioEngine (string client_name)
52 session_remove_pending = false;
55 last_monitor_check = 0;
56 monitor_check_interval = max_frames;
57 _processed_frames = 0;
58 _freewheeling = false;
63 _freewheeling = false;
64 _freewheel_thread_registered = false;
67 g_atomic_int_set (&m_meter_exit, 0);
69 if (connect_to_jack (client_name)) {
70 throw NoBackendAvailable ();
73 start_metering_thread();
77 AudioEngine::~AudioEngine ()
80 jack_client_close (_jack);
83 stop_metering_thread ();
87 _thread_init_callback (void *arg)
89 /* make sure that anybody who needs to know about this thread
93 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
102 nframes_t blocksize = jack_get_buffer_size (_jack);
104 session->set_block_size (blocksize);
105 session->set_frame_rate (jack_get_sample_rate (_jack));
107 /* page in as much of the session process code as we
108 can before we really start running.
111 session->process (blocksize);
112 session->process (blocksize);
113 session->process (blocksize);
114 session->process (blocksize);
115 session->process (blocksize);
116 session->process (blocksize);
117 session->process (blocksize);
118 session->process (blocksize);
121 _processed_frames = 0;
122 last_monitor_check = 0;
124 jack_on_shutdown (_jack, halted, this);
125 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
126 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
127 jack_set_process_callback (_jack, _process_callback, this);
128 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
129 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
130 jack_set_xrun_callback (_jack, _xrun_callback, this);
131 jack_set_sync_callback (_jack, _jack_sync_callback, this);
132 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
134 if (Config->get_jack_time_master()) {
135 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
138 if (jack_activate (_jack) == 0) {
141 Running(); /* EMIT SIGNAL */
143 error << _("cannot activate JACK client") << endmsg;
147 return _running ? 0 : -1;
151 AudioEngine::stop (bool forever)
156 jack_client_t* foo = _jack;
158 jack_client_close (foo);
159 stop_metering_thread ();
161 jack_deactivate (_jack);
163 Stopped(); /* EMIT SIGNAL */
166 return _running ? -1 : 0;
172 AudioEngine::get_sync_offset (nframes_t& offset) const
175 #ifdef HAVE_JACK_VIDEO_SUPPORT
179 (void) jack_transport_query (_jack, &pos);
181 if (pos.valid & JackVideoFrameOffset) {
182 offset = pos.video_offset;
192 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
193 jack_position_t* pos, int new_position, void *arg)
195 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
199 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
200 jack_position_t* pos, int new_position)
202 if (_jack && session && session->synced_to_jack()) {
203 session->jack_timebase_callback (state, nframes, pos, new_position);
208 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
210 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
214 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
216 if (_jack && session) {
217 return session->jack_sync_callback (state, pos);
224 AudioEngine::_xrun_callback (void *arg)
226 AudioEngine* ae = static_cast<AudioEngine*> (arg);
228 ae->Xrun (); /* EMIT SIGNAL */
234 AudioEngine::_graph_order_callback (void *arg)
236 AudioEngine* ae = static_cast<AudioEngine*> (arg);
238 ae->GraphReordered (); /* EMIT SIGNAL */
244 AudioEngine::_process_callback (nframes_t nframes, void *arg)
246 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
250 AudioEngine::_freewheel_callback (int onoff, void *arg)
252 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
256 AudioEngine::process_callback (nframes_t nframes)
258 // CycleTimer ct ("AudioEngine::process");
259 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
260 nframes_t next_processed_frames;
262 /* handle wrap around of total frames counter */
264 if (max_frames - _processed_frames < nframes) {
265 next_processed_frames = nframes - (max_frames - _processed_frames);
267 next_processed_frames = _processed_frames + nframes;
270 if (!tm.locked() || session == 0) {
271 _processed_frames = next_processed_frames;
275 if (session_remove_pending) {
277 session_remove_pending = false;
278 session_removed.signal();
279 _processed_frames = next_processed_frames;
284 if (Freewheel (nframes)) {
285 _freewheeling = false;
286 jack_set_freewheel (_jack, false);
291 session->process (nframes);
294 /* we were zombified, maybe because a ladspa plugin took
295 too long, or jackd exited, or something like that.
298 _processed_frames = next_processed_frames;
302 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
304 boost::shared_ptr<Ports> p = ports.reader();
306 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
311 if (port->_last_monitor != (x = port->monitoring_input ())) {
312 port->_last_monitor = x;
313 /* XXX I think this is dangerous, due to
314 a likely mutex in the signal handlers ...
316 port->MonitorInputChanged (x); /* EMIT SIGNAL */
319 last_monitor_check = next_processed_frames;
322 _processed_frames = next_processed_frames;
327 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
329 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
333 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
335 _frame_rate = nframes;
336 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
338 /* check for monitor input change every 1/10th of second */
340 monitor_check_interval = nframes / 10;
341 last_monitor_check = 0;
344 session->set_frame_rate (nframes);
347 SampleRateChanged (nframes); /* EMIT SIGNAL */
353 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
355 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
359 AudioEngine::jack_bufsize_callback (nframes_t nframes)
361 _buffer_size = nframes;
362 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
363 last_monitor_check = 0;
365 boost::shared_ptr<Ports> p = ports.reader();
367 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
372 session->set_block_size (_buffer_size);
379 AudioEngine::stop_metering_thread ()
381 if (m_meter_thread) {
382 g_atomic_int_set (&m_meter_exit, 1);
383 m_meter_thread->join ();
389 AudioEngine::start_metering_thread ()
391 if (m_meter_thread == 0) {
392 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread), true);
397 AudioEngine::meter_thread ()
400 Glib::usleep (10000); /* 1/100th sec interval */
401 if (g_atomic_int_get(&m_meter_exit)) {
404 IO::update_meters ();
409 AudioEngine::set_session (Session *s)
417 AudioEngine::remove_session ()
419 Glib::Mutex::Lock lm (_process_lock);
424 session_remove_pending = true;
425 session_removed.wait(_process_lock);
438 AudioEngine::register_input_port (DataType type, const string& portname)
442 fatal << _("register input port called before engine was started") << endmsg;
449 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
455 if ((newport = new Port (p)) != 0) {
456 RCUWriter<Ports> writer (ports);
457 boost::shared_ptr<Ports> ps = writer.get_copy ();
458 ps->insert (ps->begin(), newport);
459 /* writer goes out of scope, forces update */
466 _process_lock.unlock();
467 throw PortRegistrationFailure();
474 AudioEngine::register_output_port (DataType type, const string& portname)
478 fatal << _("register output port called before engine was started") << endmsg;
487 if ((p = jack_port_register (_jack, portname.c_str(),
488 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
493 RCUWriter<Ports> writer (ports);
494 boost::shared_ptr<Ports> ps = writer.get_copy ();
496 newport = new Port (p);
497 ps->insert (ps->begin(), newport);
499 /* writer goes out of scope, forces update */
506 _process_lock.unlock();
507 throw PortRegistrationFailure ();
515 AudioEngine::unregister_port (Port *port)
518 /* probably happening when the engine has been halted by JACK,
519 in which case, there is nothing we can do here.
526 int ret = jack_port_unregister (_jack, port->_port);
532 RCUWriter<Ports> writer (ports);
533 boost::shared_ptr<Ports> ps = writer.get_copy ();
535 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
542 /* writer goes out of scope, forces update */
545 remove_connections_for (port);
556 AudioEngine::connect (const string& source, const string& destination)
560 fatal << _("connect called before engine was started") << endmsg;
567 string s = make_port_name_non_relative (source);
568 string d = make_port_name_non_relative (destination);
570 int ret = jack_connect (_jack, s.c_str(), d.c_str());
573 pair<string,string> c (s, d);
574 port_connections.push_back (c);
575 } else if (ret == EEXIST) {
576 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
577 source, s, destination, d)
580 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
581 source, s, destination, d)
589 AudioEngine::disconnect (const string& source, const string& destination)
593 fatal << _("disconnect called before engine was started") << endmsg;
600 string s = make_port_name_non_relative (source);
601 string d = make_port_name_non_relative (destination);
603 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
606 pair<string,string> c (s, d);
607 PortConnections::iterator i;
609 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
610 port_connections.erase (i);
618 AudioEngine::disconnect (Port *port)
622 fatal << _("disconnect called before engine was started") << endmsg;
629 int ret = jack_port_disconnect (_jack, port->_port);
632 remove_connections_for (port);
640 AudioEngine::frame_rate ()
643 if (_frame_rate == 0) {
644 return (_frame_rate = jack_get_sample_rate (_jack));
649 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
657 AudioEngine::frames_per_cycle ()
660 if (_buffer_size == 0) {
661 return (_buffer_size = jack_get_buffer_size (_jack));
666 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
674 AudioEngine::get_port_by_name (const string& portname, bool keep)
676 Glib::Mutex::Lock lm (_process_lock);
680 fatal << _("get_port_by_name() called before engine was started") << endmsg;
687 /* check to see if we have a Port for this name already */
689 boost::shared_ptr<Ports> pr = ports.reader();
691 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
692 if (portname == (*i)->name()) {
699 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
700 Port *newport = new Port (p);
703 if (keep && newport->is_mine (_jack)) {
704 RCUWriter<Ports> writer (ports);
705 boost::shared_ptr<Ports> ps = writer.get_copy ();
706 ps->insert (newport);
707 /* writer goes out of scope, forces update */
720 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
724 fatal << _("get_ports called before engine was started") << endmsg;
730 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
734 AudioEngine::halted (void *arg)
736 AudioEngine* ae = static_cast<AudioEngine *> (arg);
738 ae->_running = false;
741 ae->_buffer_size = 0;
744 ae->Halted(); /* EMIT SIGNAL */
748 AudioEngine::n_physical_outputs () const
757 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
762 for (i = 0; ports[i]; ++i);
769 AudioEngine::n_physical_inputs () const
778 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
783 for (i = 0; ports[i]; ++i);
790 AudioEngine::get_physical_inputs (vector<string>& ins)
799 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
804 for (i = 0; ports[i]; ++i) {
805 ins.push_back (ports[i]);
812 AudioEngine::get_physical_outputs (vector<string>& outs)
821 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
826 for (i = 0; ports[i]; ++i) {
827 outs.push_back (ports[i]);
834 AudioEngine::get_nth_physical (uint32_t n, int flag)
840 if (!_running || !_jack) {
842 fatal << _("get_nth_physical called before engine was started") << endmsg;
849 ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|flag);
855 for (i = 0; i < n && ports[i]; ++i);
861 free ((char *) ports);
867 AudioEngine::get_port_total_latency (const Port& port)
870 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
876 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
881 return jack_port_get_total_latency (_jack, port._port);
885 AudioEngine::transport_stop ()
887 // cerr << "tell JACK to stop\n";
889 jack_transport_stop (_jack);
894 AudioEngine::transport_start ()
896 // cerr << "tell JACK to start\n";
898 jack_transport_start (_jack);
903 AudioEngine::transport_locate (nframes_t where)
905 // cerr << "tell JACK to locate to " << where << endl;
907 jack_transport_locate (_jack, where);
911 AudioEngine::TransportState
912 AudioEngine::transport_state ()
916 return (TransportState) jack_transport_query (_jack, &pos);
918 return (TransportState) JackTransportStopped;
923 AudioEngine::reset_timebase ()
926 if (Config->get_jack_time_master()) {
927 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
929 return jack_release_timebase (_jack);
937 AudioEngine::freewheel (bool onoff)
942 _freewheel_thread_registered = false;
945 return jack_set_freewheel (_jack, onoff);
953 AudioEngine::remove_all_ports ()
955 /* process lock MUST be held */
958 boost::shared_ptr<Ports> p = ports.reader();
960 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
961 jack_port_unregister (_jack, (*i)->_port);
966 RCUWriter<Ports> writer (ports);
967 boost::shared_ptr<Ports> ps = writer.get_copy ();
971 port_connections.clear ();
975 AudioEngine::remove_connections_for (Port* port)
977 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
978 PortConnections::iterator tmp;
983 if ((*i).first == port->name()) {
984 port_connections.erase (i);
991 #ifdef HAVE_JACK_CLIENT_OPEN
994 AudioEngine::connect_to_jack (string client_name)
996 jack_options_t options = JackNullOption;
997 jack_status_t status;
998 const char *server_name = NULL;
1000 jack_client_name = client_name; /* might be reset below */
1002 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1004 if (_jack == NULL) {
1006 if (status & JackServerFailed) {
1007 error << _("Unable to connect to JACK server") << endmsg;
1010 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
1014 if (status & JackServerStarted) {
1015 info << _("JACK server started") << endmsg;
1018 if (status & JackNameNotUnique) {
1019 jack_client_name = jack_get_client_name (_jack);
1028 AudioEngine::connect_to_jack (string client_name)
1030 jack_client_name = client_name;
1032 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1039 #endif /* HAVE_JACK_CLIENT_OPEN */
1042 AudioEngine::disconnect_from_jack ()
1048 if (jack_client_close (_jack)) {
1049 error << _("cannot shutdown connection to JACK") << endmsg;
1057 Stopped(); /* EMIT SIGNAL */
1065 AudioEngine::reconnect_to_jack ()
1068 disconnect_from_jack ();
1069 /* XXX give jackd a chance */
1070 Glib::usleep (250000);
1073 if (connect_to_jack (jack_client_name)) {
1074 error << _("failed to connect to JACK") << endmsg;
1080 boost::shared_ptr<Ports> p = ports.reader ();
1082 for (i = p->begin(); i != p->end(); ++i) {
1084 /* XXX hack hack hack */
1086 string long_name = (*i)->name();
1089 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1091 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
1092 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1099 if ((*i)->flags() & JackPortIsOutput) {
1100 (*i)->silence (jack_get_buffer_size (_jack), 0);
1104 if (i != p->end()) {
1106 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1107 jack_port_unregister (_jack, (*i)->_port);
1114 nframes_t blocksize = jack_get_buffer_size (_jack);
1115 session->set_block_size (blocksize);
1116 session->set_frame_rate (jack_get_sample_rate (_jack));
1119 last_monitor_check = 0;
1121 jack_on_shutdown (_jack, halted, this);
1122 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1123 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1124 jack_set_process_callback (_jack, _process_callback, this);
1125 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1126 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1127 jack_set_xrun_callback (_jack, _xrun_callback, this);
1128 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1129 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1131 if (Config->get_jack_time_master()) {
1132 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1135 if (jack_activate (_jack) == 0) {
1142 /* re-establish connections */
1144 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1148 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1149 if (err != EEXIST) {
1150 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1151 (*i).first, (*i).second, err)
1157 Running (); /* EMIT SIGNAL*/
1163 AudioEngine::request_buffer_size (nframes_t nframes)
1166 int ret = jack_set_buffer_size (_jack, nframes);
1174 AudioEngine::update_total_latencies ()
1176 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1177 jack_recompute_total_latencies (_jack);
1182 AudioEngine::make_port_name_relative (string portname)
1184 string::size_type len;
1185 string::size_type n;
1187 len = portname.length();
1189 for (n = 0; n < len; ++n) {
1190 if (portname[n] == ':') {
1195 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1196 return portname.substr (n+1);
1203 AudioEngine::make_port_name_non_relative (string portname)
1207 if (portname.find_first_of (':') != string::npos) {
1211 str = jack_client_name;