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/port.h>
30 #include <ardour/session.h>
31 #include <ardour/cycle_timer.h>
32 #include <ardour/utils.h>
37 #include <ardour/timestamps.h>
42 using namespace ARDOUR;
44 jack_nframes_t Port::short_over_length = 2;
45 jack_nframes_t Port::long_over_length = 10;
47 AudioEngine::AudioEngine (string client_name)
50 session_remove_pending = false;
53 last_monitor_check = 0;
54 monitor_check_interval = max_frames;
55 _processed_frames = 0;
56 _freewheeling = false;
61 _freewheeling = false;
62 _freewheel_thread_registered = false;
67 start_metering_thread();
69 if (connect_to_jack (client_name)) {
70 throw NoBackendAvailable ();
75 AudioEngine::~AudioEngine ()
78 jack_client_close (_jack);
82 g_atomic_int_inc(&m_meter_exit);
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);
96 if (Config->get_use_vst()) {
103 AudioEngine::start ()
108 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
110 session->set_block_size (blocksize);
111 session->set_frame_rate (jack_get_sample_rate (_jack));
113 /* page in as much of the session process code as we
114 can before we really start running.
117 session->process (blocksize);
118 session->process (blocksize);
119 session->process (blocksize);
120 session->process (blocksize);
121 session->process (blocksize);
122 session->process (blocksize);
123 session->process (blocksize);
124 session->process (blocksize);
127 _processed_frames = 0;
128 last_monitor_check = 0;
130 jack_on_shutdown (_jack, halted, this);
131 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
132 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
133 jack_set_process_callback (_jack, _process_callback, this);
134 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
135 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
136 jack_set_xrun_callback (_jack, _xrun_callback, this);
137 jack_set_sync_callback (_jack, _jack_sync_callback, this);
138 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
140 if (Config->get_jack_time_master()) {
141 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
144 if (jack_activate (_jack) == 0) {
147 Running(); /* EMIT SIGNAL */
149 error << _("cannot activate JACK client") << endmsg;
153 return _running ? 0 : -1;
161 jack_deactivate (_jack);
162 Stopped(); /* EMIT SIGNAL */
165 return _running ? -1 : 0;
170 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
172 jack_position_t* pos, int new_position, void *arg)
174 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
178 AudioEngine::jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
180 jack_position_t* pos, int new_position)
182 if (session && session->synced_to_jack()) {
183 session->jack_timebase_callback (state, nframes, pos, new_position);
188 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
190 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
194 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
197 return session->jack_sync_callback (state, pos);
204 AudioEngine::_xrun_callback (void *arg)
206 static_cast<AudioEngine *>(arg)->Xrun (); /* EMIT SIGNAL */
211 AudioEngine::_graph_order_callback (void *arg)
213 static_cast<AudioEngine *>(arg)->GraphReordered (); /* EMIT SIGNAL */
218 AudioEngine::_process_callback (jack_nframes_t nframes, void *arg)
220 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
224 AudioEngine::_freewheel_callback (int onoff, void *arg)
226 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
230 AudioEngine::process_callback (jack_nframes_t nframes)
232 // CycleTimer ct ("AudioEngine::process");
233 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
234 jack_nframes_t next_processed_frames;
236 /* handle wrap around of total frames counter */
238 if (max_frames - _processed_frames < nframes) {
239 next_processed_frames = nframes - (max_frames - _processed_frames);
241 next_processed_frames = _processed_frames + nframes;
244 if (!tm.locked() || session == 0) {
245 _processed_frames = next_processed_frames;
249 if (session_remove_pending) {
251 session_remove_pending = false;
252 session_removed.signal();
253 _processed_frames = next_processed_frames;
258 if (Freewheel (nframes)) {
259 _freewheeling = false;
260 jack_set_freewheel (_jack, false);
265 session->process (nframes);
268 /* we were zombified, maybe because a ladspa plugin took
269 too long, or jackd exited, or something like that.
272 _processed_frames = next_processed_frames;
276 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
277 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
282 if (port->last_monitor != (x = port->monitoring_input ())) {
283 port->last_monitor = x;
284 /* XXX I think this is dangerous, due to
285 a likely mutex in the signal handlers ...
287 port->MonitorInputChanged (x); /* EMIT SIGNAL */
290 last_monitor_check = next_processed_frames;
293 _processed_frames = next_processed_frames;
298 AudioEngine::_sample_rate_callback (jack_nframes_t nframes, void *arg)
300 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
304 AudioEngine::jack_sample_rate_callback (jack_nframes_t nframes)
306 _frame_rate = nframes;
307 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
309 /* check for monitor input change every 1/10th of second */
311 monitor_check_interval = nframes / 10;
312 last_monitor_check = 0;
315 session->set_frame_rate (nframes);
318 SampleRateChanged (nframes); /* EMIT SIGNAL */
324 AudioEngine::_bufsize_callback (jack_nframes_t nframes, void *arg)
326 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
330 AudioEngine::jack_bufsize_callback (jack_nframes_t nframes)
332 _buffer_size = nframes;
333 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
334 last_monitor_check = 0;
336 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
341 session->set_block_size (_buffer_size);
348 AudioEngine::start_metering_thread ()
350 if(m_meter_thread == 0) {
351 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread), false);
356 AudioEngine::meter_thread ()
358 while (g_atomic_int_get(&m_meter_exit) != true) {
359 Glib::usleep (10000); /* 1/100th sec interval */
360 IO::update_meters ();
366 AudioEngine::set_session (Session *s)
374 AudioEngine::remove_session ()
376 Glib::Mutex::Lock lm (_process_lock);
381 session_remove_pending = true;
382 session_removed.wait(_process_lock);
396 AudioEngine::register_audio_input_port (const string& portname)
400 fatal << _("register audio input port called before engine was started") << endmsg;
407 jack_port_t *p = jack_port_register (_jack, portname.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
412 if ((newport = new Port (p)) != 0) {
413 ports.insert (ports.begin(), newport);
419 _process_lock.unlock();
420 throw PortRegistrationFailure();
427 AudioEngine::register_audio_output_port (const string& portname)
431 fatal << _("register audio output port called before engine was started") << endmsg;
440 if ((p = jack_port_register (_jack, portname.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0)) != 0) {
441 Port *newport = new Port (p);
442 ports.insert (ports.begin(), newport);
447 _process_lock.unlock();
448 throw PortRegistrationFailure ();
455 AudioEngine::unregister_port (Port *port)
458 /* probably happening when the engine has been halted by JACK,
459 in which case, there is nothing we can do here.
466 int ret = jack_port_unregister (_jack, port->port);
470 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
477 remove_connections_for (port);
488 AudioEngine::connect (const string& source, const string& destination)
492 fatal << _("connect called before engine was started") << endmsg;
499 string s = make_port_name_non_relative (source);
500 string d = make_port_name_non_relative (destination);
502 int ret = jack_connect (_jack, s.c_str(), d.c_str());
505 pair<string,string> c (s, d);
506 port_connections.push_back (c);
508 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
509 source, s, destination, d)
517 AudioEngine::disconnect (const string& source, const string& destination)
521 fatal << _("disconnect called before engine was started") << endmsg;
528 string s = make_port_name_non_relative (source);
529 string d = make_port_name_non_relative (destination);
531 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
534 pair<string,string> c (s, d);
535 PortConnections::iterator i;
537 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
538 port_connections.erase (i);
546 AudioEngine::disconnect (Port *port)
550 fatal << _("disconnect called before engine was started") << endmsg;
557 int ret = jack_port_disconnect (_jack, port->port);
560 remove_connections_for (port);
568 AudioEngine::frame_rate ()
571 if (_frame_rate == 0) {
572 return (_frame_rate = jack_get_sample_rate (_jack));
577 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
585 AudioEngine::frames_per_cycle ()
588 if (_buffer_size == 0) {
589 return (_buffer_size = jack_get_buffer_size (_jack));
594 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
602 AudioEngine::get_port_by_name (const string& portname, bool keep)
604 Glib::Mutex::Lock lm (_process_lock);
608 fatal << _("get_port_by_name() called before engine was started") << endmsg;
615 /* check to see if we have a Port for this name already */
617 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
618 if (portname == (*i)->name()) {
625 if ((p = jack_port_by_name (_jack, portname.c_str())) != 0) {
626 Port *newport = new Port (p);
627 if (keep && newport->is_mine (_jack)) {
628 ports.insert (newport);
637 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
641 fatal << _("get_ports called before engine was started") << endmsg;
647 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
651 AudioEngine::halted (void *arg)
653 AudioEngine *ae = reinterpret_cast<AudioEngine *> (arg);
655 ae->_running = false;
658 ae->_buffer_size = 0;
661 ae->Halted(); /* EMIT SIGNAL */
665 AudioEngine::n_physical_outputs () const
674 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
679 for (i = 0; ports[i]; ++i);
686 AudioEngine::n_physical_inputs () const
695 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
700 for (i = 0; ports[i]; ++i);
708 AudioEngine::get_nth_physical (uint32_t n, int flag)
714 if (!_running || !_jack) {
716 fatal << _("get_nth_physical called before engine was started") << endmsg;
723 ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|flag);
729 for (i = 0; i < n && ports[i]; ++i);
735 free ((char *) ports);
741 AudioEngine::get_port_total_latency (const Port& port)
744 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
750 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
755 return jack_port_get_total_latency (_jack, port.port);
759 AudioEngine::transport_stop ()
761 // cerr << "tell JACK to stop\n";
763 jack_transport_stop (_jack);
768 AudioEngine::transport_start ()
770 // cerr << "tell JACK to start\n";
772 jack_transport_start (_jack);
777 AudioEngine::transport_locate (jack_nframes_t where)
779 // cerr << "tell JACK to locate to " << where << endl;
781 jack_transport_locate (_jack, where);
785 AudioEngine::TransportState
786 AudioEngine::transport_state ()
790 return (TransportState) jack_transport_query (_jack, &pos);
792 return (TransportState) JackTransportStopped;
797 AudioEngine::reset_timebase ()
800 if (Config->get_jack_time_master()) {
801 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
803 return jack_release_timebase (_jack);
811 AudioEngine::freewheel (bool onoff)
816 _freewheel_thread_registered = false;
819 return jack_set_freewheel (_jack, onoff);
827 AudioEngine::remove_all_ports ()
829 /* process lock MUST be held */
832 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
833 jack_port_unregister (_jack, (*i)->port);
838 port_connections.clear ();
842 AudioEngine::remove_connections_for (Port* port)
844 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
845 PortConnections::iterator tmp;
850 if ((*i).first == port->name()) {
851 port_connections.erase (i);
858 #ifdef HAVE_JACK_CLIENT_OPEN
861 AudioEngine::connect_to_jack (string client_name)
863 jack_options_t options = JackNullOption;
864 jack_status_t status;
865 const char *server_name = NULL;
867 jack_client_name = client_name; /* might be reset below */
869 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
873 if (status & JackServerFailed) {
874 error << _("Unable to connect to JACK server") << endmsg;
877 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
881 if (status & JackServerStarted) {
882 info << _("JACK server started") << endmsg;
885 if (status & JackNameNotUnique) {
886 jack_client_name = jack_get_client_name (_jack);
895 AudioEngine::connect_to_jack (string client_name)
897 jack_client_name = client_name;
899 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
906 #endif /* HAVE_JACK_CLIENT_OPEN */
909 AudioEngine::disconnect_from_jack ()
915 if (jack_client_close (_jack)) {
916 error << _("cannot shutdown connection to JACK") << endmsg;
924 Stopped(); /* EMIT SIGNAL */
932 AudioEngine::reconnect_to_jack ()
935 disconnect_from_jack ();
936 /* XXX give jackd a chance */
937 Glib::usleep (250000);
940 if (connect_to_jack (jack_client_name)) {
941 error << _("failed to connect to JACK") << endmsg;
947 for (i = ports.begin(); i != ports.end(); ++i) {
949 /* XXX hack hack hack */
951 string long_name = (*i)->name();
954 short_name = long_name.substr (long_name.find_last_of (':') + 1);
956 if (((*i)->port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
957 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
964 if ((*i)->flags() & JackPortIsOutput) {
965 (*i)->silence (jack_get_buffer_size (_jack), 0);
969 if (i != ports.end()) {
970 for (Ports::iterator i = ports.begin(); i != ports.end(); ++i) {
971 jack_port_unregister (_jack, (*i)->port);
978 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
979 session->set_block_size (blocksize);
980 session->set_frame_rate (jack_get_sample_rate (_jack));
983 last_monitor_check = 0;
985 jack_on_shutdown (_jack, halted, this);
986 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
987 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
988 jack_set_process_callback (_jack, _process_callback, this);
989 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
990 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
991 jack_set_xrun_callback (_jack, _xrun_callback, this);
992 jack_set_sync_callback (_jack, _jack_sync_callback, this);
993 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
995 if (Config->get_jack_time_master()) {
996 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
999 if (jack_activate (_jack) == 0) {
1006 /* re-establish connections */
1008 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1012 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1013 if (err != EEXIST) {
1014 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1015 (*i).first, (*i).second, err)
1021 Running (); /* EMIT SIGNAL*/
1027 AudioEngine::request_buffer_size (jack_nframes_t nframes)
1030 int ret = jack_set_buffer_size (_jack, nframes);
1038 AudioEngine::update_total_latencies ()
1040 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1041 jack_recompute_total_latencies (_jack);
1046 AudioEngine::make_port_name_relative (string portname)
1048 string::size_type len;
1049 string::size_type n;
1051 len = portname.length();
1053 for (n = 0; n < len; ++n) {
1054 if (portname[n] == ':') {
1059 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1060 return portname.substr (n+1);
1067 AudioEngine::make_port_name_non_relative (string portname)
1071 if (portname.find_first_of (':') != string::npos) {
1075 str = jack_client_name;