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;
168 AudioEngine::get_sync_offset (jack_nframes_t& offset) const
171 #ifdef HAVE_JACK_VIDEO_SUPPORT
175 (void) jack_transport_query (_jack, &pos);
177 if (pos.valid & JackVideoFrameOffset) {
178 offset = pos.video_offset;
188 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
189 jack_position_t* pos, int new_position, void *arg)
191 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
195 AudioEngine::jack_timebase_callback (jack_transport_state_t state, jack_nframes_t nframes,
196 jack_position_t* pos, int new_position)
198 if (session && session->synced_to_jack()) {
199 session->jack_timebase_callback (state, nframes, pos, new_position);
204 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
206 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
210 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
213 return session->jack_sync_callback (state, pos);
220 AudioEngine::_xrun_callback (void *arg)
222 static_cast<AudioEngine *>(arg)->Xrun (); /* EMIT SIGNAL */
227 AudioEngine::_graph_order_callback (void *arg)
229 static_cast<AudioEngine *>(arg)->GraphReordered (); /* EMIT SIGNAL */
234 AudioEngine::_process_callback (jack_nframes_t nframes, void *arg)
236 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
240 AudioEngine::_freewheel_callback (int onoff, void *arg)
242 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
246 AudioEngine::process_callback (jack_nframes_t nframes)
248 // CycleTimer ct ("AudioEngine::process");
249 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
250 jack_nframes_t next_processed_frames;
252 /* handle wrap around of total frames counter */
254 if (max_frames - _processed_frames < nframes) {
255 next_processed_frames = nframes - (max_frames - _processed_frames);
257 next_processed_frames = _processed_frames + nframes;
260 if (!tm.locked() || session == 0) {
261 _processed_frames = next_processed_frames;
265 if (session_remove_pending) {
267 session_remove_pending = false;
268 session_removed.signal();
269 _processed_frames = next_processed_frames;
274 if (Freewheel (nframes)) {
275 _freewheeling = false;
276 jack_set_freewheel (_jack, false);
281 boost::shared_ptr<Ports> p = ports.reader();
283 // Prepare ports (ie read data if necessary)
284 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
285 (*i)->cycle_start(nframes);
287 session->process (nframes);
290 /* we were zombified, maybe because a ladspa plugin took
291 too long, or jackd exited, or something like that.
294 _processed_frames = next_processed_frames;
298 // Finalize ports (ie write data if necessary)
299 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
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 (jack_nframes_t nframes, void *arg)
329 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
333 AudioEngine::jack_sample_rate_callback (jack_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 (jack_nframes_t nframes, void *arg)
355 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
359 AudioEngine::jack_bufsize_callback (jack_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::start_metering_thread ()
381 if(m_meter_thread == 0) {
382 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread), false);
387 AudioEngine::meter_thread ()
389 while (g_atomic_int_get(&m_meter_exit) != true) {
390 Glib::usleep (10000); /* 1/100th sec interval */
391 IO::update_meters ();
397 AudioEngine::set_session (Session *s)
405 AudioEngine::remove_session ()
407 Glib::Mutex::Lock lm (_process_lock);
412 session_remove_pending = true;
413 session_removed.wait(_process_lock);
427 AudioEngine::register_input_port (DataType type, const string& portname)
431 fatal << _("register input port called before engine was started") << endmsg;
438 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
444 if (type == DataType::AUDIO)
445 newport = new AudioPort (p);
446 else if (type == DataType::MIDI)
447 newport = new MidiPort (p);
449 throw unknown_type();
452 RCUWriter<Ports> writer (ports);
453 boost::shared_ptr<Ports> ps = writer.get_copy ();
454 ps->insert (ps->begin(), newport);
455 /* writer goes out of scope, forces update */
462 _process_lock.unlock();
463 throw PortRegistrationFailure();
470 AudioEngine::register_output_port (DataType type, const string& portname)
474 fatal << _("register output port called before engine was started") << endmsg;
483 if ((p = jack_port_register (_jack, portname.c_str(),
484 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
488 if (type == DataType::AUDIO)
489 newport = new AudioPort (p);
490 else if (type == DataType::MIDI)
491 newport = new MidiPort (p);
493 throw unknown_type ();
496 RCUWriter<Ports> writer (ports);
497 boost::shared_ptr<Ports> ps = writer.get_copy ();
498 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.
524 int ret = jack_port_unregister (_jack, port._port);
530 RCUWriter<Ports> writer (ports);
531 boost::shared_ptr<Ports> ps = writer.get_copy ();
533 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
540 /* writer goes out of scope, forces update */
543 remove_connections_for (port);
550 AudioEngine::connect (const string& source, const string& destination)
554 fatal << _("connect called before engine was started") << endmsg;
561 string s = make_port_name_non_relative (source);
562 string d = make_port_name_non_relative (destination);
564 int ret = jack_connect (_jack, s.c_str(), d.c_str());
567 pair<string,string> c (s, d);
568 port_connections.push_back (c);
570 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
571 source, s, destination, d)
579 AudioEngine::disconnect (const string& source, const string& destination)
583 fatal << _("disconnect called before engine was started") << endmsg;
590 string s = make_port_name_non_relative (source);
591 string d = make_port_name_non_relative (destination);
593 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
596 pair<string,string> c (s, d);
597 PortConnections::iterator i;
599 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
600 port_connections.erase (i);
608 AudioEngine::disconnect (Port& port)
612 fatal << _("disconnect called before engine was started") << endmsg;
619 int ret = jack_port_disconnect (_jack, port._port);
622 remove_connections_for (port);
630 AudioEngine::frame_rate ()
633 if (_frame_rate == 0) {
634 return (_frame_rate = jack_get_sample_rate (_jack));
639 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
647 AudioEngine::frames_per_cycle ()
650 if (_buffer_size == 0) {
651 return (_buffer_size = jack_get_buffer_size (_jack));
656 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
663 /** Get a port by name.
664 * Note this can return NULL, it will NOT create a port if it is not found (any more).
667 AudioEngine::get_port_by_name (const string& portname, bool keep)
669 Glib::Mutex::Lock lm (_process_lock);
673 fatal << _("get_port_by_name() called before engine was started") << endmsg;
680 boost::shared_ptr<Ports> pr = ports.reader();
682 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
683 if (portname == (*i)->name()) {
692 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
696 fatal << _("get_ports called before engine was started") << endmsg;
702 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
706 AudioEngine::halted (void *arg)
708 AudioEngine *ae = reinterpret_cast<AudioEngine *> (arg);
710 ae->_running = false;
713 ae->_buffer_size = 0;
716 ae->Halted(); /* EMIT SIGNAL */
720 AudioEngine::n_physical_outputs () const
729 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
734 for (i = 0; ports[i]; ++i);
741 AudioEngine::n_physical_inputs () const
750 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
755 for (i = 0; ports[i]; ++i);
762 AudioEngine::get_physical_inputs (vector<string>& ins)
771 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
776 for (i = 0; ports[i]; ++i) {
777 ins.push_back (ports[i]);
784 AudioEngine::get_physical_outputs (vector<string>& outs)
793 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
798 for (i = 0; ports[i]; ++i) {
799 outs.push_back (ports[i]);
806 AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
812 assert(type != DataType::NIL);
814 if (!_running || !_jack) {
816 fatal << _("get_nth_physical called before engine was started") << endmsg;
823 ports = jack_get_ports (_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag);
829 for (i = 0; i < n && ports[i]; ++i);
835 free ((char *) ports);
841 AudioEngine::get_port_total_latency (const Port& port)
844 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
850 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
855 return jack_port_get_total_latency (_jack, port._port);
859 AudioEngine::transport_stop ()
861 // cerr << "tell JACK to stop\n";
863 jack_transport_stop (_jack);
868 AudioEngine::transport_start ()
870 // cerr << "tell JACK to start\n";
872 jack_transport_start (_jack);
877 AudioEngine::transport_locate (jack_nframes_t where)
879 // cerr << "tell JACK to locate to " << where << endl;
881 jack_transport_locate (_jack, where);
885 AudioEngine::TransportState
886 AudioEngine::transport_state ()
890 return (TransportState) jack_transport_query (_jack, &pos);
892 return (TransportState) JackTransportStopped;
897 AudioEngine::reset_timebase ()
900 if (Config->get_jack_time_master()) {
901 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
903 return jack_release_timebase (_jack);
911 AudioEngine::freewheel (bool onoff)
916 _freewheel_thread_registered = false;
919 return jack_set_freewheel (_jack, onoff);
927 AudioEngine::remove_all_ports ()
929 /* process lock MUST be held */
932 boost::shared_ptr<Ports> p = ports.reader();
934 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
935 jack_port_unregister (_jack, (*i)->_port);
940 RCUWriter<Ports> writer (ports);
941 boost::shared_ptr<Ports> ps = writer.get_copy ();
945 port_connections.clear ();
949 AudioEngine::remove_connections_for (Port& port)
951 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
952 PortConnections::iterator tmp;
957 if ((*i).first == port.name()) {
958 port_connections.erase (i);
965 #ifdef HAVE_JACK_CLIENT_OPEN
968 AudioEngine::connect_to_jack (string client_name)
970 jack_options_t options = JackNullOption;
971 jack_status_t status;
972 const char *server_name = NULL;
974 jack_client_name = client_name; /* might be reset below */
976 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
980 if (status & JackServerFailed) {
981 error << _("Unable to connect to JACK server") << endmsg;
984 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
988 if (status & JackServerStarted) {
989 info << _("JACK server started") << endmsg;
992 if (status & JackNameNotUnique) {
993 jack_client_name = jack_get_client_name (_jack);
1002 AudioEngine::connect_to_jack (string client_name)
1004 jack_client_name = client_name;
1006 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1013 #endif /* HAVE_JACK_CLIENT_OPEN */
1016 AudioEngine::disconnect_from_jack ()
1022 if (jack_client_close (_jack)) {
1023 error << _("cannot shutdown connection to JACK") << endmsg;
1031 Stopped(); /* EMIT SIGNAL */
1039 AudioEngine::reconnect_to_jack ()
1042 disconnect_from_jack ();
1043 /* XXX give jackd a chance */
1044 Glib::usleep (250000);
1047 if (connect_to_jack (jack_client_name)) {
1048 error << _("failed to connect to JACK") << endmsg;
1054 boost::shared_ptr<Ports> p = ports.reader ();
1056 for (i = p->begin(); i != p->end(); ++i) {
1058 /* XXX hack hack hack */
1060 string long_name = (*i)->name();
1063 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1065 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type().to_jack_type(), (*i)->flags(), 0)) == 0) {
1066 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1073 if ((*i)->flags() & JackPortIsOutput) {
1074 (*i)->get_buffer().silence (jack_get_buffer_size (_jack), 0);
1078 if (i != p->end()) {
1080 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1081 jack_port_unregister (_jack, (*i)->_port);
1088 jack_nframes_t blocksize = jack_get_buffer_size (_jack);
1089 session->set_block_size (blocksize);
1090 session->set_frame_rate (jack_get_sample_rate (_jack));
1093 last_monitor_check = 0;
1095 jack_on_shutdown (_jack, halted, this);
1096 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1097 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1098 jack_set_process_callback (_jack, _process_callback, this);
1099 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1100 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1101 jack_set_xrun_callback (_jack, _xrun_callback, this);
1102 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1103 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1105 if (Config->get_jack_time_master()) {
1106 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1109 if (jack_activate (_jack) == 0) {
1116 /* re-establish connections */
1118 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1122 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1123 if (err != EEXIST) {
1124 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1125 (*i).first, (*i).second, err)
1131 Running (); /* EMIT SIGNAL*/
1137 AudioEngine::request_buffer_size (jack_nframes_t nframes)
1140 int ret = jack_set_buffer_size (_jack, nframes);
1148 AudioEngine::update_total_latencies ()
1150 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1151 jack_recompute_total_latencies (_jack);
1156 AudioEngine::make_port_name_relative (string portname)
1158 string::size_type len;
1159 string::size_type n;
1161 len = portname.length();
1163 for (n = 0; n < len; ++n) {
1164 if (portname[n] == ':') {
1169 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1170 return portname.substr (n+1);
1177 AudioEngine::make_port_name_non_relative (string portname)
1181 if (portname.find_first_of (':') != string::npos) {
1185 str = jack_client_name;