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/unknown_type.h>
29 #include <ardour/audioengine.h>
30 #include <ardour/buffer.h>
31 #include <ardour/port.h>
32 #include <ardour/audio_port.h>
33 #include <ardour/midi_port.h>
34 #include <ardour/session.h>
35 #include <ardour/cycle_timer.h>
36 #include <ardour/utils.h>
41 #include <ardour/timestamps.h>
46 using namespace ARDOUR;
49 AudioEngine::AudioEngine (string client_name)
53 session_remove_pending = false;
56 last_monitor_check = 0;
57 monitor_check_interval = max_frames;
58 _processed_frames = 0;
59 _freewheeling = false;
64 _freewheeling = false;
65 _freewheel_thread_registered = false;
70 if (connect_to_jack (client_name)) {
71 throw NoBackendAvailable ();
74 start_metering_thread();
78 AudioEngine::~AudioEngine ()
81 jack_client_close (_jack);
85 g_atomic_int_inc(&m_meter_exit);
90 _thread_init_callback (void *arg)
92 /* make sure that anybody who needs to know about this thread
96 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
100 AudioEngine::start ()
105 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
107 session->set_block_size (blocksize);
108 session->set_frame_rate (jack_get_sample_rate (_jack));
110 /* page in as much of the session process code as we
111 can before we really start running.
114 session->process (blocksize);
115 session->process (blocksize);
116 session->process (blocksize);
117 session->process (blocksize);
118 session->process (blocksize);
119 session->process (blocksize);
120 session->process (blocksize);
121 session->process (blocksize);
124 _processed_frames = 0;
125 last_monitor_check = 0;
127 jack_on_shutdown (_jack, halted, this);
128 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
129 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
130 jack_set_process_callback (_jack, _process_callback, this);
131 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
132 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
133 jack_set_xrun_callback (_jack, _xrun_callback, this);
134 jack_set_sync_callback (_jack, _jack_sync_callback, this);
135 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
137 if (Config->get_jack_time_master()) {
138 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
141 if (jack_activate (_jack) == 0) {
144 Running(); /* EMIT SIGNAL */
146 error << _("cannot activate JACK client") << endmsg;
150 return _running ? 0 : -1;
158 jack_deactivate (_jack);
159 Stopped(); /* EMIT SIGNAL */
162 return _running ? -1 : 0;
167 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
169 jack_position_t* pos, int new_position, void *arg)
171 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
175 AudioEngine::jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
177 jack_position_t* pos, int new_position)
179 if (session && session->synced_to_jack()) {
180 session->jack_timebase_callback (state, nframes, pos, new_position);
185 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
187 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
191 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
194 return session->jack_sync_callback (state, pos);
201 AudioEngine::_xrun_callback (void *arg)
203 static_cast<AudioEngine *>(arg)->Xrun (); /* EMIT SIGNAL */
208 AudioEngine::_graph_order_callback (void *arg)
210 static_cast<AudioEngine *>(arg)->GraphReordered (); /* EMIT SIGNAL */
215 AudioEngine::_process_callback (jack_nframes_t nframes, void *arg)
217 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
221 AudioEngine::_freewheel_callback (int onoff, void *arg)
223 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
227 AudioEngine::process_callback (jack_nframes_t nframes)
229 // CycleTimer ct ("AudioEngine::process");
230 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
231 jack_nframes_t next_processed_frames;
233 /* handle wrap around of total frames counter */
235 if (max_frames - _processed_frames < nframes) {
236 next_processed_frames = nframes - (max_frames - _processed_frames);
238 next_processed_frames = _processed_frames + nframes;
241 if (!tm.locked() || session == 0) {
242 _processed_frames = next_processed_frames;
246 if (session_remove_pending) {
248 session_remove_pending = false;
249 session_removed.signal();
250 _processed_frames = next_processed_frames;
255 if (Freewheel (nframes)) {
256 _freewheeling = false;
257 jack_set_freewheel (_jack, false);
262 boost::shared_ptr<Ports> p = ports.reader();
264 // Prepare ports (ie read data if necessary)
265 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
266 (*i)->cycle_start(nframes);
268 session->process (nframes);
271 /* we were zombified, maybe because a ladspa plugin took
272 too long, or jackd exited, or something like that.
275 _processed_frames = next_processed_frames;
279 // Finalize ports (ie write data if necessary)
280 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
283 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
285 boost::shared_ptr<Ports> p = ports.reader();
287 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
292 if (port->_last_monitor != (x = port->monitoring_input ())) {
293 port->_last_monitor = x;
294 /* XXX I think this is dangerous, due to
295 a likely mutex in the signal handlers ...
297 port->MonitorInputChanged (x); /* EMIT SIGNAL */
300 last_monitor_check = next_processed_frames;
303 _processed_frames = next_processed_frames;
308 AudioEngine::_sample_rate_callback (jack_nframes_t nframes, void *arg)
310 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
314 AudioEngine::jack_sample_rate_callback (jack_nframes_t nframes)
316 _frame_rate = nframes;
317 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
319 /* check for monitor input change every 1/10th of second */
321 monitor_check_interval = nframes / 10;
322 last_monitor_check = 0;
325 session->set_frame_rate (nframes);
328 SampleRateChanged (nframes); /* EMIT SIGNAL */
334 AudioEngine::_bufsize_callback (jack_nframes_t nframes, void *arg)
336 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
340 AudioEngine::jack_bufsize_callback (jack_nframes_t nframes)
342 _buffer_size = nframes;
343 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
344 last_monitor_check = 0;
346 boost::shared_ptr<Ports> p = ports.reader();
348 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
353 session->set_block_size (_buffer_size);
360 AudioEngine::start_metering_thread ()
362 if(m_meter_thread == 0) {
363 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread), false);
368 AudioEngine::meter_thread ()
370 while (g_atomic_int_get(&m_meter_exit) != true) {
371 Glib::usleep (10000); /* 1/100th sec interval */
372 IO::update_meters ();
378 AudioEngine::set_session (Session *s)
386 AudioEngine::remove_session ()
388 Glib::Mutex::Lock lm (_process_lock);
393 session_remove_pending = true;
394 session_removed.wait(_process_lock);
408 AudioEngine::register_input_port (DataType type, const string& portname)
412 fatal << _("register input port called before engine was started") << endmsg;
419 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
425 if (type == DataType::AUDIO)
426 newport = new AudioPort (p);
427 else if (type == DataType::MIDI)
428 newport = new MidiPort (p);
430 throw unknown_type();
433 RCUWriter<Ports> writer (ports);
434 boost::shared_ptr<Ports> ps = writer.get_copy ();
435 ps->insert (ps->begin(), newport);
436 /* writer goes out of scope, forces update */
443 _process_lock.unlock();
444 throw PortRegistrationFailure();
451 AudioEngine::register_output_port (DataType type, const string& portname)
455 fatal << _("register output port called before engine was started") << endmsg;
464 if ((p = jack_port_register (_jack, portname.c_str(),
465 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
469 if (type == DataType::AUDIO)
470 newport = new AudioPort (p);
471 else if (type == DataType::MIDI)
472 newport = new MidiPort (p);
474 throw unknown_type ();
477 RCUWriter<Ports> writer (ports);
478 boost::shared_ptr<Ports> ps = writer.get_copy ();
479 ps->insert (ps->begin(), newport);
480 /* writer goes out of scope, forces update */
487 _process_lock.unlock();
488 throw PortRegistrationFailure ();
496 AudioEngine::unregister_port (Port& port)
499 /* probably happening when the engine has been halted by JACK,
500 in which case, there is nothing we can do here.
505 int ret = jack_port_unregister (_jack, port._port);
511 RCUWriter<Ports> writer (ports);
512 boost::shared_ptr<Ports> ps = writer.get_copy ();
514 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
521 /* writer goes out of scope, forces update */
524 remove_connections_for (port);
531 AudioEngine::connect (const string& source, const string& destination)
535 fatal << _("connect called before engine was started") << endmsg;
542 string s = make_port_name_non_relative (source);
543 string d = make_port_name_non_relative (destination);
545 int ret = jack_connect (_jack, s.c_str(), d.c_str());
548 pair<string,string> c (s, d);
549 port_connections.push_back (c);
551 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
552 source, s, destination, d)
560 AudioEngine::disconnect (const string& source, const string& destination)
564 fatal << _("disconnect called before engine was started") << endmsg;
571 string s = make_port_name_non_relative (source);
572 string d = make_port_name_non_relative (destination);
574 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
577 pair<string,string> c (s, d);
578 PortConnections::iterator i;
580 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
581 port_connections.erase (i);
589 AudioEngine::disconnect (Port& port)
593 fatal << _("disconnect called before engine was started") << endmsg;
600 int ret = jack_port_disconnect (_jack, port._port);
603 remove_connections_for (port);
611 AudioEngine::frame_rate ()
614 if (_frame_rate == 0) {
615 return (_frame_rate = jack_get_sample_rate (_jack));
620 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
628 AudioEngine::frames_per_cycle ()
631 if (_buffer_size == 0) {
632 return (_buffer_size = jack_get_buffer_size (_jack));
637 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
644 /** Get a port by name.
645 * Note this can return NULL, it will NOT create a port if it is not found (any more).
648 AudioEngine::get_port_by_name (const string& portname, bool keep)
650 Glib::Mutex::Lock lm (_process_lock);
654 fatal << _("get_port_by_name() called before engine was started") << endmsg;
661 boost::shared_ptr<Ports> pr = ports.reader();
663 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
664 if (portname == (*i)->name()) {
673 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
677 fatal << _("get_ports called before engine was started") << endmsg;
683 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
687 AudioEngine::halted (void *arg)
689 AudioEngine *ae = reinterpret_cast<AudioEngine *> (arg);
691 ae->_running = false;
694 ae->_buffer_size = 0;
697 ae->Halted(); /* EMIT SIGNAL */
701 AudioEngine::n_physical_outputs () const
710 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
715 for (i = 0; ports[i]; ++i);
722 AudioEngine::n_physical_inputs () const
731 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
736 for (i = 0; ports[i]; ++i);
743 AudioEngine::get_physical_inputs (vector<string>& ins)
752 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
757 for (i = 0; ports[i]; ++i) {
758 ins.push_back (ports[i]);
765 AudioEngine::get_physical_outputs (vector<string>& outs)
774 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
779 for (i = 0; ports[i]; ++i) {
780 outs.push_back (ports[i]);
787 AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
793 assert(type != DataType::NIL);
795 if (!_running || !_jack) {
797 fatal << _("get_nth_physical called before engine was started") << endmsg;
804 ports = jack_get_ports (_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag);
810 for (i = 0; i < n && ports[i]; ++i);
816 free ((char *) ports);
822 AudioEngine::get_port_total_latency (const Port& port)
825 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
831 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
836 return jack_port_get_total_latency (_jack, port._port);
840 AudioEngine::transport_stop ()
842 // cerr << "tell JACK to stop\n";
844 jack_transport_stop (_jack);
849 AudioEngine::transport_start ()
851 // cerr << "tell JACK to start\n";
853 jack_transport_start (_jack);
858 AudioEngine::transport_locate (jack_nframes_t where)
860 // cerr << "tell JACK to locate to " << where << endl;
862 jack_transport_locate (_jack, where);
866 AudioEngine::TransportState
867 AudioEngine::transport_state ()
871 return (TransportState) jack_transport_query (_jack, &pos);
873 return (TransportState) JackTransportStopped;
878 AudioEngine::reset_timebase ()
881 if (Config->get_jack_time_master()) {
882 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
884 return jack_release_timebase (_jack);
892 AudioEngine::freewheel (bool onoff)
897 _freewheel_thread_registered = false;
900 return jack_set_freewheel (_jack, onoff);
908 AudioEngine::remove_all_ports ()
910 /* process lock MUST be held */
913 boost::shared_ptr<Ports> p = ports.reader();
915 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
916 jack_port_unregister (_jack, (*i)->_port);
921 RCUWriter<Ports> writer (ports);
922 boost::shared_ptr<Ports> ps = writer.get_copy ();
926 port_connections.clear ();
930 AudioEngine::remove_connections_for (Port& port)
932 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
933 PortConnections::iterator tmp;
938 if ((*i).first == port.name()) {
939 port_connections.erase (i);
946 #ifdef HAVE_JACK_CLIENT_OPEN
949 AudioEngine::connect_to_jack (string client_name)
951 jack_options_t options = JackNullOption;
952 jack_status_t status;
953 const char *server_name = NULL;
955 jack_client_name = client_name; /* might be reset below */
957 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
961 if (status & JackServerFailed) {
962 error << _("Unable to connect to JACK server") << endmsg;
965 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
969 if (status & JackServerStarted) {
970 info << _("JACK server started") << endmsg;
973 if (status & JackNameNotUnique) {
974 jack_client_name = jack_get_client_name (_jack);
983 AudioEngine::connect_to_jack (string client_name)
985 jack_client_name = client_name;
987 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
994 #endif /* HAVE_JACK_CLIENT_OPEN */
997 AudioEngine::disconnect_from_jack ()
1003 if (jack_client_close (_jack)) {
1004 error << _("cannot shutdown connection to JACK") << endmsg;
1012 Stopped(); /* EMIT SIGNAL */
1020 AudioEngine::reconnect_to_jack ()
1023 disconnect_from_jack ();
1024 /* XXX give jackd a chance */
1025 Glib::usleep (250000);
1028 if (connect_to_jack (jack_client_name)) {
1029 error << _("failed to connect to JACK") << endmsg;
1035 boost::shared_ptr<Ports> p = ports.reader ();
1037 for (i = p->begin(); i != p->end(); ++i) {
1039 /* XXX hack hack hack */
1041 string long_name = (*i)->name();
1044 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1046 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type().to_jack_type(), (*i)->flags(), 0)) == 0) {
1047 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1054 if ((*i)->flags() & JackPortIsOutput) {
1055 (*i)->silence (jack_get_buffer_size (_jack), 0);
1059 if (i != p->end()) {
1061 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1062 jack_port_unregister (_jack, (*i)->_port);
1069 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
1070 session->set_block_size (blocksize);
1071 session->set_frame_rate (jack_get_sample_rate (_jack));
1074 last_monitor_check = 0;
1076 jack_on_shutdown (_jack, halted, this);
1077 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1078 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1079 jack_set_process_callback (_jack, _process_callback, this);
1080 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1081 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1082 jack_set_xrun_callback (_jack, _xrun_callback, this);
1083 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1084 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1086 if (Config->get_jack_time_master()) {
1087 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1090 if (jack_activate (_jack) == 0) {
1097 /* re-establish connections */
1099 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1103 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1104 if (err != EEXIST) {
1105 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1106 (*i).first, (*i).second, err)
1112 Running (); /* EMIT SIGNAL*/
1118 AudioEngine::request_buffer_size (jack_nframes_t nframes)
1121 int ret = jack_set_buffer_size (_jack, nframes);
1129 AudioEngine::update_total_latencies ()
1131 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1132 jack_recompute_total_latencies (_jack);
1137 AudioEngine::make_port_name_relative (string portname)
1139 string::size_type len;
1140 string::size_type n;
1142 len = portname.length();
1144 for (n = 0; n < len; ++n) {
1145 if (portname[n] == ':') {
1150 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1151 return portname.substr (n+1);
1158 AudioEngine::make_port_name_non_relative (string portname)
1162 if (portname.find_first_of (':') != string::npos) {
1166 str = jack_client_name;