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 jack_nframes_t Port::_short_over_length = 2;
47 jack_nframes_t Port::_long_over_length = 10;
49 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;
69 start_metering_thread();
71 if (connect_to_jack (client_name)) {
72 throw NoBackendAvailable ();
77 AudioEngine::~AudioEngine ()
80 jack_client_close (_jack);
84 g_atomic_int_inc(&m_meter_exit);
89 _thread_init_callback (void *arg)
91 /* make sure that anybody who needs to know about this thread
95 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
104 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
106 session->set_block_size (blocksize);
107 session->set_frame_rate (jack_get_sample_rate (_jack));
109 /* page in as much of the session process code as we
110 can before we really start running.
113 session->process (blocksize);
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);
123 _processed_frames = 0;
124 last_monitor_check = 0;
126 jack_on_shutdown (_jack, halted, this);
127 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
128 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
129 jack_set_process_callback (_jack, _process_callback, this);
130 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
131 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
132 jack_set_xrun_callback (_jack, _xrun_callback, this);
133 jack_set_sync_callback (_jack, _jack_sync_callback, this);
134 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
136 if (Config->get_jack_time_master()) {
137 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
140 if (jack_activate (_jack) == 0) {
143 Running(); /* EMIT SIGNAL */
145 error << _("cannot activate JACK client") << endmsg;
149 return _running ? 0 : -1;
157 jack_deactivate (_jack);
158 Stopped(); /* EMIT SIGNAL */
161 return _running ? -1 : 0;
166 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
168 jack_position_t* pos, int new_position, void *arg)
170 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
174 AudioEngine::jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
176 jack_position_t* pos, int new_position)
178 if (session && session->synced_to_jack()) {
179 session->jack_timebase_callback (state, nframes, pos, new_position);
184 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
186 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
190 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
193 return session->jack_sync_callback (state, pos);
200 AudioEngine::_xrun_callback (void *arg)
202 static_cast<AudioEngine *>(arg)->Xrun (); /* EMIT SIGNAL */
207 AudioEngine::_graph_order_callback (void *arg)
209 static_cast<AudioEngine *>(arg)->GraphReordered (); /* EMIT SIGNAL */
214 AudioEngine::_process_callback (jack_nframes_t nframes, void *arg)
216 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
220 AudioEngine::_freewheel_callback (int onoff, void *arg)
222 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
226 AudioEngine::process_callback (jack_nframes_t nframes)
228 // CycleTimer ct ("AudioEngine::process");
229 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
230 jack_nframes_t next_processed_frames;
232 /* handle wrap around of total frames counter */
234 if (max_frames - _processed_frames < nframes) {
235 next_processed_frames = nframes - (max_frames - _processed_frames);
237 next_processed_frames = _processed_frames + nframes;
240 if (!tm.locked() || session == 0) {
241 _processed_frames = next_processed_frames;
245 if (session_remove_pending) {
247 session_remove_pending = false;
248 session_removed.signal();
249 _processed_frames = next_processed_frames;
254 if (Freewheel (nframes)) {
255 _freewheeling = false;
256 jack_set_freewheel (_jack, false);
261 session->process (nframes);
264 /* we were zombified, maybe because a ladspa plugin took
265 too long, or jackd exited, or something like that.
268 _processed_frames = next_processed_frames;
272 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
273 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
278 if (port->_last_monitor != (x = port->monitoring_input ())) {
279 port->_last_monitor = x;
280 /* XXX I think this is dangerous, due to
281 a likely mutex in the signal handlers ...
283 port->MonitorInputChanged (x); /* EMIT SIGNAL */
286 last_monitor_check = next_processed_frames;
289 _processed_frames = next_processed_frames;
294 AudioEngine::_sample_rate_callback (jack_nframes_t nframes, void *arg)
296 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
300 AudioEngine::jack_sample_rate_callback (jack_nframes_t nframes)
302 _frame_rate = nframes;
303 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
305 /* check for monitor input change every 1/10th of second */
307 monitor_check_interval = nframes / 10;
308 last_monitor_check = 0;
311 session->set_frame_rate (nframes);
314 SampleRateChanged (nframes); /* EMIT SIGNAL */
320 AudioEngine::_bufsize_callback (jack_nframes_t nframes, void *arg)
322 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
326 AudioEngine::jack_bufsize_callback (jack_nframes_t nframes)
328 _buffer_size = nframes;
329 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
330 last_monitor_check = 0;
332 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
337 session->set_block_size (_buffer_size);
344 AudioEngine::start_metering_thread ()
346 if(m_meter_thread == 0) {
347 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread), false);
352 AudioEngine::meter_thread ()
354 while (g_atomic_int_get(&m_meter_exit) != true) {
355 Glib::usleep (10000); /* 1/100th sec interval */
356 IO::update_meters ();
362 AudioEngine::set_session (Session *s)
370 AudioEngine::remove_session ()
372 Glib::Mutex::Lock lm (_process_lock);
377 session_remove_pending = true;
378 session_removed.wait(_process_lock);
392 AudioEngine::register_input_port (DataType type, const string& portname)
396 fatal << _("register input port called before engine was started") << endmsg;
403 jack_port_t *p = jack_port_register (_jack, portname.c_str(),
404 type.to_jack_type(), JackPortIsInput, 0);
409 if ((newport = new Port (p)) != 0) {
410 ports.insert (ports.begin(), newport);
416 _process_lock.unlock();
417 throw PortRegistrationFailure();
424 AudioEngine::register_output_port (DataType type, const string& portname)
428 fatal << _("register output port called before engine was started") << endmsg;
437 if ((p = jack_port_register (_jack, portname.c_str(),
438 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
439 Port *newport = new Port (p);
440 ports.insert (ports.begin(), newport);
445 _process_lock.unlock();
446 throw PortRegistrationFailure ();
454 AudioEngine::unregister_port (Port *port)
457 /* probably happening when the engine has been halted by JACK,
458 in which case, there is nothing we can do here.
465 int ret = jack_port_unregister (_jack, port->_port);
469 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
476 remove_connections_for (port);
487 AudioEngine::connect (const string& source, const string& destination)
491 fatal << _("connect called before engine was started") << endmsg;
498 string s = make_port_name_non_relative (source);
499 string d = make_port_name_non_relative (destination);
501 int ret = jack_connect (_jack, s.c_str(), d.c_str());
504 pair<string,string> c (s, d);
505 port_connections.push_back (c);
507 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
508 source, s, destination, d)
516 AudioEngine::disconnect (const string& source, const string& destination)
520 fatal << _("disconnect called before engine was started") << endmsg;
527 string s = make_port_name_non_relative (source);
528 string d = make_port_name_non_relative (destination);
530 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
533 pair<string,string> c (s, d);
534 PortConnections::iterator i;
536 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
537 port_connections.erase (i);
545 AudioEngine::disconnect (Port *port)
549 fatal << _("disconnect called before engine was started") << endmsg;
556 int ret = jack_port_disconnect (_jack, port->_port);
559 remove_connections_for (port);
567 AudioEngine::frame_rate ()
570 if (_frame_rate == 0) {
571 return (_frame_rate = jack_get_sample_rate (_jack));
576 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
584 AudioEngine::frames_per_cycle ()
587 if (_buffer_size == 0) {
588 return (_buffer_size = jack_get_buffer_size (_jack));
593 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
601 AudioEngine::get_port_by_name (const string& portname, bool keep)
603 Glib::Mutex::Lock lm (_process_lock);
607 fatal << _("get_port_by_name() called before engine was started") << endmsg;
614 /* check to see if we have a Port for this name already */
616 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
617 if (portname == (*i)->name()) {
624 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
625 Port *newport = new Port (p);
626 if (keep && newport->is_mine (_jack)) {
627 ports.insert (newport);
636 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
640 fatal << _("get_ports called before engine was started") << endmsg;
646 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
650 AudioEngine::halted (void *arg)
652 AudioEngine *ae = reinterpret_cast<AudioEngine *> (arg);
654 ae->_running = false;
657 ae->_buffer_size = 0;
660 ae->Halted(); /* EMIT SIGNAL */
664 AudioEngine::n_physical_outputs () const
673 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
678 for (i = 0; ports[i]; ++i);
685 AudioEngine::n_physical_inputs () const
694 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
699 for (i = 0; ports[i]; ++i);
706 AudioEngine::get_nth_physical (uint32_t n, int flag)
712 if (!_running || !_jack) {
714 fatal << _("get_nth_physical called before engine was started") << endmsg;
721 ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|flag);
727 for (i = 0; i < n && ports[i]; ++i);
733 free ((char *) ports);
739 AudioEngine::get_port_total_latency (const Port& port)
742 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
748 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
753 return jack_port_get_total_latency (_jack, port._port);
757 AudioEngine::transport_stop ()
759 // cerr << "tell JACK to stop\n";
761 jack_transport_stop (_jack);
766 AudioEngine::transport_start ()
768 // cerr << "tell JACK to start\n";
770 jack_transport_start (_jack);
775 AudioEngine::transport_locate (jack_nframes_t where)
777 // cerr << "tell JACK to locate to " << where << endl;
779 jack_transport_locate (_jack, where);
783 AudioEngine::TransportState
784 AudioEngine::transport_state ()
788 return (TransportState) jack_transport_query (_jack, &pos);
790 return (TransportState) JackTransportStopped;
795 AudioEngine::reset_timebase ()
798 if (Config->get_jack_time_master()) {
799 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
801 return jack_release_timebase (_jack);
809 AudioEngine::freewheel (bool onoff)
814 _freewheel_thread_registered = false;
817 return jack_set_freewheel (_jack, onoff);
825 AudioEngine::remove_all_ports ()
827 /* process lock MUST be held */
830 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
831 jack_port_unregister (_jack, (*i)->_port);
836 port_connections.clear ();
840 AudioEngine::remove_connections_for (Port* port)
842 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
843 PortConnections::iterator tmp;
848 if ((*i).first == port->name()) {
849 port_connections.erase (i);
856 #ifdef HAVE_JACK_CLIENT_OPEN
859 AudioEngine::connect_to_jack (string client_name)
861 jack_options_t options = JackNullOption;
862 jack_status_t status;
863 const char *server_name = NULL;
865 jack_client_name = client_name; /* might be reset below */
867 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
871 if (status & JackServerFailed) {
872 error << _("Unable to connect to JACK server") << endmsg;
875 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
879 if (status & JackServerStarted) {
880 info << _("JACK server started") << endmsg;
883 if (status & JackNameNotUnique) {
884 jack_client_name = jack_get_client_name (_jack);
893 AudioEngine::connect_to_jack (string client_name)
895 jack_client_name = client_name;
897 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
904 #endif /* HAVE_JACK_CLIENT_OPEN */
907 AudioEngine::disconnect_from_jack ()
913 if (jack_client_close (_jack)) {
914 error << _("cannot shutdown connection to JACK") << endmsg;
922 Stopped(); /* EMIT SIGNAL */
930 AudioEngine::reconnect_to_jack ()
933 disconnect_from_jack ();
934 /* XXX give jackd a chance */
935 Glib::usleep (250000);
938 if (connect_to_jack (jack_client_name)) {
939 error << _("failed to connect to JACK") << endmsg;
945 for (i = ports.begin(); i != ports.end(); ++i) {
947 /* XXX hack hack hack */
949 string long_name = (*i)->name();
952 short_name = long_name.substr (long_name.find_last_of (':') + 1);
954 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
955 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
962 if ((*i)->flags() & JackPortIsOutput) {
963 (*i)->silence (jack_get_buffer_size (_jack), 0);
967 if (i != ports.end()) {
968 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
969 jack_port_unregister (_jack, (*i)->_port);
976 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
977 session->set_block_size (blocksize);
978 session->set_frame_rate (jack_get_sample_rate (_jack));
981 last_monitor_check = 0;
983 jack_on_shutdown (_jack, halted, this);
984 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
985 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
986 jack_set_process_callback (_jack, _process_callback, this);
987 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
988 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
989 jack_set_xrun_callback (_jack, _xrun_callback, this);
990 jack_set_sync_callback (_jack, _jack_sync_callback, this);
991 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
993 if (Config->get_jack_time_master()) {
994 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
997 if (jack_activate (_jack) == 0) {
1004 /* re-establish connections */
1006 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1010 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1011 if (err != EEXIST) {
1012 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1013 (*i).first, (*i).second, err)
1019 Running (); /* EMIT SIGNAL*/
1025 AudioEngine::request_buffer_size (jack_nframes_t nframes)
1028 int ret = jack_set_buffer_size (_jack, nframes);
1036 AudioEngine::update_total_latencies ()
1038 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1039 jack_recompute_total_latencies (_jack);
1044 AudioEngine::make_port_name_relative (string portname)
1046 string::size_type len;
1047 string::size_type n;
1049 len = portname.length();
1051 for (n = 0; n < len; ++n) {
1052 if (portname[n] == ':') {
1057 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1058 return portname.substr (n+1);
1065 AudioEngine::make_port_name_non_relative (string portname)
1069 if (portname.find_first_of (':') != string::npos) {
1073 str = jack_client_name;