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 <pbd/pthread_utils.h>
26 #include <ardour/audioengine.h>
27 #include <ardour/port.h>
28 #include <ardour/session.h>
29 #include <ardour/cycle_timer.h>
30 #include <ardour/utils.h>
35 #include <ardour/timestamps.h>
40 using namespace ARDOUR;
42 jack_nframes_t Port::short_over_length = 2;
43 jack_nframes_t Port::long_over_length = 10;
45 AudioEngine::AudioEngine (string client_name)
47 pthread_cond_init (&session_removed, 0);
49 session_remove_pending = false;
52 last_monitor_check = 0;
53 monitor_check_interval = max_frames;
54 _processed_frames = 0;
55 _freewheeling = false;
60 _freewheeling = false;
61 _freewheel_thread_registered = false;
63 if (connect_to_jack (client_name)) {
64 throw NoBackendAvailable ();
69 AudioEngine::~AudioEngine ()
72 jack_client_close (_jack);
77 _thread_init_callback (void *arg)
79 /* make sure that anybody who needs to know about this thread
83 PBD::ThreadCreated (pthread_self(), X_("Audioengine"));
86 if (Config->get_use_vst()) {
98 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
100 session->set_block_size (blocksize);
101 session->set_frame_rate (jack_get_sample_rate (_jack));
103 /* page in as much of the session process code as we
104 can before we really start running.
107 session->process (blocksize);
108 session->process (blocksize);
109 session->process (blocksize);
110 session->process (blocksize);
111 session->process (blocksize);
112 session->process (blocksize);
113 session->process (blocksize);
114 session->process (blocksize);
117 _processed_frames = 0;
118 last_monitor_check = 0;
120 jack_on_shutdown (_jack, halted, this);
121 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
122 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
123 jack_set_process_callback (_jack, _process_callback, this);
124 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
125 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
126 jack_set_xrun_callback (_jack, _xrun_callback, this);
127 jack_set_sync_callback (_jack, _jack_sync_callback, this);
128 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
130 if (Config->get_jack_time_master()) {
131 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
134 if (jack_activate (_jack) == 0) {
137 Running(); /* EMIT SIGNAL */
139 error << _("cannot activate JACK client") << endmsg;
143 return _running ? 0 : -1;
151 jack_deactivate (_jack);
152 Stopped(); /* EMIT SIGNAL */
155 return _running ? -1 : 0;
160 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
162 jack_position_t* pos, int new_position, void *arg)
164 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
168 AudioEngine::jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
170 jack_position_t* pos, int new_position)
172 if (session && session->synced_to_jack()) {
173 session->jack_timebase_callback (state, nframes, pos, new_position);
178 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
180 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
184 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
187 return session->jack_sync_callback (state, pos);
194 AudioEngine::_xrun_callback (void *arg)
196 static_cast<AudioEngine *>(arg)->Xrun (); /* EMIT SIGNAL */
201 AudioEngine::_graph_order_callback (void *arg)
203 static_cast<AudioEngine *>(arg)->GraphReordered (); /* EMIT SIGNAL */
208 AudioEngine::_process_callback (jack_nframes_t nframes, void *arg)
210 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
214 AudioEngine::_freewheel_callback (int onoff, void *arg)
216 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
220 AudioEngine::meter (Port *port, jack_nframes_t nframes)
224 jack_default_audio_sample_t *buf;
226 buf = port->get_buffer (nframes);
228 overlen = port->overlen;
231 for (jack_nframes_t n = 0; n < nframes; ++n) {
233 /* 1) peak metering */
235 peak = f_max (peak, buf[n]);
237 /* 2) clip/over metering */
241 } else if (overlen) {
242 if (overlen > Port::short_over_length) {
243 port->_short_overs++;
245 if (overlen > Port::long_over_length) {
253 /* post-loop check on the final status of overlen */
255 if (overlen > Port::short_over_length) {
256 port->_short_overs++;
258 if (overlen > Port::long_over_length) {
259 port->_short_overs++;
263 port->_peak_db= 20 * fast_log10 (peak);
265 port->_peak_db = minus_infinity();
269 port->overlen = overlen;
273 AudioEngine::process_callback (jack_nframes_t nframes)
275 TentativeLockMonitor tm (_process_lock, __LINE__, __FILE__);
276 jack_nframes_t next_processed_frames;
278 /* handle wrap around of total frames counter */
280 if (max_frames - _processed_frames < nframes) {
281 next_processed_frames = nframes - (max_frames - _processed_frames);
283 next_processed_frames = _processed_frames + nframes;
286 if (!tm.locked() || session == 0) {
287 _processed_frames = next_processed_frames;
291 if (session_remove_pending) {
293 session_remove_pending = false;
294 pthread_cond_signal (&session_removed);
295 _processed_frames = next_processed_frames;
300 if (Freewheel (nframes)) {
301 _freewheeling = false;
302 jack_set_freewheel (_jack, false);
307 /* do input peak metering */
309 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
310 if ((*i)->metering) {
311 meter ((*i), nframes);
315 session->process (nframes);
318 /* we were zombified, maybe because a ladspa plugin took
319 too long, or jackd exited, or something like that.
322 _processed_frames = next_processed_frames;
326 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
327 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
332 if (port->last_monitor != (x = port->monitoring_input ())) {
333 port->last_monitor = x;
334 /* XXX I think this is dangerous, due to
335 a likely mutex in the signal handlers ...
337 port->MonitorInputChanged (x); /* EMIT SIGNAL */
340 last_monitor_check = next_processed_frames;
343 _processed_frames = next_processed_frames;
348 AudioEngine::_sample_rate_callback (jack_nframes_t nframes, void *arg)
350 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
354 AudioEngine::jack_sample_rate_callback (jack_nframes_t nframes)
356 _frame_rate = nframes;
357 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
359 /* check for monitor input change every 1/10th of second */
361 monitor_check_interval = nframes / 10;
362 last_monitor_check = 0;
365 session->set_frame_rate (nframes);
368 SampleRateChanged (nframes); /* EMIT SIGNAL */
374 AudioEngine::_bufsize_callback (jack_nframes_t nframes, void *arg)
376 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
380 AudioEngine::jack_bufsize_callback (jack_nframes_t nframes)
382 _buffer_size = nframes;
383 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
384 last_monitor_check = 0;
386 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
391 session->set_block_size (_buffer_size);
398 AudioEngine::set_session (Session *s)
401 s->set_block_size (jack_get_buffer_size (_jack));
402 s->set_frame_rate (jack_get_sample_rate (_jack));
408 AudioEngine::remove_session ()
410 LockMonitor lm (_process_lock, __LINE__, __FILE__);
415 session_remove_pending = true;
416 pthread_cond_wait (&session_removed, _process_lock.mutex());
430 AudioEngine::register_audio_input_port (const string& portname)
434 fatal << _("register audio input port called before engine was started") << endmsg;
441 jack_port_t *p = jack_port_register (_jack, portname.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
446 if ((newport = new Port (p)) != 0) {
447 ports.insert (ports.begin(), newport);
453 pthread_mutex_unlock (_process_lock.mutex());
454 throw PortRegistrationFailure();
461 AudioEngine::register_audio_output_port (const string& portname)
465 fatal << _("register audio output port called before engine was started") << endmsg;
474 if ((p = jack_port_register (_jack, portname.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0)) != 0) {
475 Port *newport = new Port (p);
476 ports.insert (ports.begin(), newport);
481 pthread_mutex_unlock (_process_lock.mutex());
482 throw PortRegistrationFailure ();
489 AudioEngine::unregister_port (Port *port)
492 /* probably happening when the engine has been halted by JACK,
493 in which case, there is nothing we can do here.
500 int ret = jack_port_unregister (_jack, port->port);
504 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
511 remove_connections_for (port);
522 AudioEngine::connect (const string& source, const string& destination)
526 fatal << _("connect called before engine was started") << endmsg;
533 string s = make_port_name_non_relative (source);
534 string d = make_port_name_non_relative (destination);
536 int ret = jack_connect (_jack, s.c_str(), d.c_str());
539 pair<string,string> c (s, d);
540 port_connections.push_back (c);
542 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
543 source, s, destination, d)
551 AudioEngine::disconnect (const string& source, const string& destination)
555 fatal << _("disconnect called before engine was started") << endmsg;
562 string s = make_port_name_non_relative (source);
563 string d = make_port_name_non_relative (destination);
565 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
568 pair<string,string> c (s, d);
569 PortConnections::iterator i;
571 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
572 port_connections.erase (i);
580 AudioEngine::disconnect (Port *port)
584 fatal << _("disconnect called before engine was started") << endmsg;
591 int ret = jack_port_disconnect (_jack, port->port);
594 remove_connections_for (port);
602 AudioEngine::frame_rate ()
605 if (_frame_rate == 0) {
606 return (_frame_rate = jack_get_sample_rate (_jack));
611 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
619 AudioEngine::frames_per_cycle ()
622 if (_buffer_size == 0) {
623 return (_buffer_size = jack_get_buffer_size (_jack));
628 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
636 AudioEngine::get_port_by_name (const string& portname, bool keep)
638 LockMonitor lm (_process_lock, __LINE__, __FILE__);
642 fatal << _("get_port_by_name() called before engine was started") << endmsg;
649 /* check to see if we have a Port for this name already */
651 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
652 if (portname == (*i)->name()) {
659 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
660 Port *newport = new Port (p);
661 if (keep && newport->is_mine (_jack)) {
662 ports.insert (newport);
671 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
675 fatal << _("get_ports called before engine was started") << endmsg;
681 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
685 AudioEngine::halted (void *arg)
687 AudioEngine *ae = reinterpret_cast<AudioEngine *> (arg);
689 ae->_running = false;
692 ae->_buffer_size = 0;
695 ae->Halted(); /* EMIT SIGNAL */
699 AudioEngine::n_physical_outputs () const
708 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
713 for (i = 0; ports[i]; ++i);
720 AudioEngine::n_physical_inputs () const
729 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
734 for (i = 0; ports[i]; ++i);
742 AudioEngine::get_nth_physical (uint32_t n, int flag)
748 if (!_running || !_jack) {
750 fatal << _("get_nth_physical called before engine was started") << endmsg;
757 ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|flag);
763 for (i = 0; i < n && ports[i]; ++i);
769 free ((char *) ports);
775 AudioEngine::get_port_total_latency (const Port& port)
778 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
784 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
789 return jack_port_get_total_latency (_jack, port.port);
793 AudioEngine::transport_stop ()
795 // cerr << "tell JACK to stop\n";
797 jack_transport_stop (_jack);
802 AudioEngine::transport_start ()
804 // cerr << "tell JACK to start\n";
806 jack_transport_start (_jack);
811 AudioEngine::transport_locate (jack_nframes_t where)
813 // cerr << "tell JACK to locate to " << where << endl;
815 jack_transport_locate (_jack, where);
819 AudioEngine::TransportState
820 AudioEngine::transport_state ()
824 return (TransportState) jack_transport_query (_jack, &pos);
826 return (TransportState) JackTransportStopped;
831 AudioEngine::reset_timebase ()
834 if (Config->get_jack_time_master()) {
835 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
837 return jack_release_timebase (_jack);
845 AudioEngine::freewheel (bool onoff)
850 _freewheel_thread_registered = false;
853 return jack_set_freewheel (_jack, onoff);
861 AudioEngine::remove_all_ports ()
863 /* process lock MUST be held */
866 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
867 jack_port_unregister (_jack, (*i)->port);
872 port_connections.clear ();
876 AudioEngine::remove_connections_for (Port* port)
878 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
879 PortConnections::iterator tmp;
884 if ((*i).first == port->name()) {
885 port_connections.erase (i);
892 #ifdef HAVE_JACK_CLIENT_OPEN
895 AudioEngine::connect_to_jack (string client_name)
897 jack_options_t options = JackNullOption;
898 jack_status_t status;
899 const char *server_name = NULL;
901 jack_client_name = client_name; /* might be reset below */
903 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
907 if (status & JackServerFailed) {
908 error << _("Unable to connect to JACK server") << endmsg;
911 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
915 if (status & JackServerStarted) {
916 info << _("JACK server started") << endmsg;
919 if (status & JackNameNotUnique) {
920 jack_client_name = jack_get_client_name (_jack);
929 AudioEngine::connect_to_jack (string client_name)
931 jack_client_name = client_name;
933 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
940 #endif /* HAVE_JACK_CLIENT_OPEN */
943 AudioEngine::disconnect_from_jack ()
949 if (jack_client_close (_jack)) {
950 error << _("cannot shutdown connection to JACK") << endmsg;
958 Stopped(); /* EMIT SIGNAL */
966 AudioEngine::reconnect_to_jack ()
969 disconnect_from_jack ();
970 /* XXX give jackd a chance */
974 if (connect_to_jack (jack_client_name)) {
975 error << _("failed to connect to JACK") << endmsg;
981 for (i = ports.begin(); i != ports.end(); ++i) {
983 /* XXX hack hack hack */
985 string long_name = (*i)->name();
988 short_name = long_name.substr (long_name.find_last_of (':') + 1);
990 if (((*i)->port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
991 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
998 if ((*i)->flags() & JackPortIsOutput) {
999 (*i)->silence (jack_get_buffer_size (_jack), 0);
1003 if (i != ports.end()) {
1004 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
1005 jack_port_unregister (_jack, (*i)->port);
1012 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
1013 session->set_block_size (blocksize);
1014 session->set_frame_rate (jack_get_sample_rate (_jack));
1017 last_monitor_check = 0;
1019 jack_on_shutdown (_jack, halted, this);
1020 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1021 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1022 jack_set_process_callback (_jack, _process_callback, this);
1023 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1024 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1025 jack_set_xrun_callback (_jack, _xrun_callback, this);
1026 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1027 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1029 if (Config->get_jack_time_master()) {
1030 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1033 if (jack_activate (_jack) == 0) {
1040 /* re-establish connections */
1042 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1046 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1047 if (err != EEXIST) {
1048 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1049 (*i).first, (*i).second, err)
1055 Running (); /* EMIT SIGNAL*/
1061 AudioEngine::request_buffer_size (jack_nframes_t nframes)
1064 int ret = jack_set_buffer_size (_jack, nframes);
1072 AudioEngine::update_total_latencies ()
1074 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1075 jack_recompute_total_latencies (_jack);
1080 AudioEngine::make_port_name_relative (string portname)
1082 string::size_type len;
1083 string::size_type n;
1085 len = portname.length();
1087 for (n = 0; n < len; ++n) {
1088 if (portname[n] == ':') {
1093 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1094 return portname.substr (n+1);
1101 AudioEngine::make_port_name_non_relative (string portname)
1105 if (portname.find_first_of (':') != string::npos) {
1109 str = jack_client_name;