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.
26 #include <glibmm/timer.h>
27 #include <pbd/pthread_utils.h>
28 #include <pbd/stacktrace.h>
29 #include <pbd/unknown_type.h>
31 #include <ardour/audioengine.h>
32 #include <ardour/buffer.h>
33 #include <ardour/port.h>
34 #include <ardour/audio_port.h>
35 #include <ardour/midi_port.h>
36 #include <ardour/session.h>
37 #include <ardour/cycle_timer.h>
38 #include <ardour/utils.h>
43 #include <ardour/timestamps.h>
48 using namespace ARDOUR;
51 gint AudioEngine::m_meter_exit;
54 ardour_jack_error (const char* msg)
56 error << "JACK: " << msg << endmsg;
59 AudioEngine::AudioEngine (string client_name)
63 session_remove_pending = false;
66 last_monitor_check = 0;
67 monitor_check_interval = max_frames;
68 _processed_frames = 0;
69 _freewheeling = false;
74 _freewheeling = false;
75 _freewheel_thread_registered = false;
78 g_atomic_int_set (&m_meter_exit, 0);
80 if (connect_to_jack (client_name)) {
81 throw NoBackendAvailable ();
84 start_metering_thread();
88 AudioEngine::~AudioEngine ()
91 Glib::Mutex::Lock tm (_process_lock);
92 session_removed.signal ();
95 jack_client_close (_jack);
98 stop_metering_thread ();
103 _thread_init_callback (void *arg)
105 /* make sure that anybody who needs to know about this thread
109 PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
113 AudioEngine::start ()
118 nframes_t blocksize = jack_get_buffer_size (_jack);
120 session->set_block_size (blocksize);
121 session->set_frame_rate (jack_get_sample_rate (_jack));
123 /* page in as much of the session process code as we
124 can before we really start running.
127 session->process (blocksize);
128 session->process (blocksize);
129 session->process (blocksize);
130 session->process (blocksize);
131 session->process (blocksize);
132 session->process (blocksize);
133 session->process (blocksize);
134 session->process (blocksize);
137 _processed_frames = 0;
138 last_monitor_check = 0;
140 jack_on_shutdown (_jack, halted, this);
141 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
142 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
143 jack_set_process_callback (_jack, _process_callback, this);
144 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
145 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
146 jack_set_xrun_callback (_jack, _xrun_callback, this);
147 jack_set_sync_callback (_jack, _jack_sync_callback, this);
148 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
150 if (Config->get_jack_time_master()) {
151 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
154 if (jack_activate (_jack) == 0) {
157 Running(); /* EMIT SIGNAL */
159 error << _("cannot activate JACK client") << endmsg;
163 return _running ? 0 : -1;
167 AudioEngine::stop (bool forever)
172 jack_client_t* foo = _jack;
174 jack_client_close (foo);
175 stop_metering_thread ();
177 jack_deactivate (_jack);
179 Stopped(); /* EMIT SIGNAL */
182 return _running ? -1 : 0;
187 AudioEngine::get_sync_offset (nframes_t& offset) const
190 #ifdef HAVE_JACK_VIDEO_SUPPORT
194 (void) jack_transport_query (_jack, &pos);
196 if (pos.valid & JackVideoFrameOffset) {
197 offset = pos.video_offset;
207 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
208 jack_position_t* pos, int new_position, void *arg)
210 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
214 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
215 jack_position_t* pos, int new_position)
217 if (_jack && session && session->synced_to_jack()) {
218 session->jack_timebase_callback (state, nframes, pos, new_position);
223 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
225 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
229 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
231 if (_jack && session) {
232 return session->jack_sync_callback (state, pos);
239 AudioEngine::_xrun_callback (void *arg)
241 AudioEngine* ae = static_cast<AudioEngine*> (arg);
243 ae->Xrun (); /* EMIT SIGNAL */
249 AudioEngine::_graph_order_callback (void *arg)
251 AudioEngine* ae = static_cast<AudioEngine*> (arg);
253 ae->GraphReordered (); /* EMIT SIGNAL */
258 /** Wrapped which is called by JACK as its process callback. It is just
259 * here to get us back into C++ land by calling AudioEngine::process_callback()
260 * @param nframes Number of frames passed by JACK.
261 * @param arg User argument passed by JACK, which will be the AudioEngine*.
264 AudioEngine::_process_callback (nframes_t nframes, void *arg)
266 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
270 AudioEngine::_freewheel_callback (int onoff, void *arg)
272 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
275 /** Method called by JACK (via _process_callback) which says that there
276 * is work to be done.
277 * @param nframes Number of frames to process.
280 AudioEngine::process_callback (nframes_t nframes)
282 // CycleTimer ct ("AudioEngine::process");
283 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
285 /// The number of frames that will have been processed when we've finished
286 nframes_t next_processed_frames;
288 /* handle wrap around of total frames counter */
290 if (max_frames - _processed_frames < nframes) {
291 next_processed_frames = nframes - (max_frames - _processed_frames);
293 next_processed_frames = _processed_frames + nframes;
296 if (!tm.locked() || session == 0) {
297 /* return having done nothing */
298 _processed_frames = next_processed_frames;
302 if (session_remove_pending) {
303 /* perform the actual session removal */
305 session_remove_pending = false;
306 session_removed.signal();
307 _processed_frames = next_processed_frames;
312 /* emit the Freewheel signal and stop freewheeling in the event of trouble */
313 if (Freewheel (nframes)) {
314 cerr << "Freewheeling returned non-zero!\n";
315 _freewheeling = false;
316 jack_set_freewheel (_jack, false);
321 boost::shared_ptr<Ports> p = ports.reader();
323 // Prepare ports (ie read data if necessary)
324 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
325 (*i)->cycle_start (nframes);
329 session->process (nframes);
333 _processed_frames = next_processed_frames;
337 // Finalize ports (ie write data if necessary)
338 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
342 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
344 boost::shared_ptr<Ports> p = ports.reader();
346 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
351 if (port->_last_monitor != (x = port->monitoring_input ())) {
352 port->_last_monitor = x;
353 /* XXX I think this is dangerous, due to
354 a likely mutex in the signal handlers ...
356 port->MonitorInputChanged (x); /* EMIT SIGNAL */
359 last_monitor_check = next_processed_frames;
362 _processed_frames = next_processed_frames;
367 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
369 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
373 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
375 _frame_rate = nframes;
376 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
378 /* check for monitor input change every 1/10th of second */
380 monitor_check_interval = nframes / 10;
381 last_monitor_check = 0;
384 session->set_frame_rate (nframes);
387 SampleRateChanged (nframes); /* EMIT SIGNAL */
393 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
395 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
399 AudioEngine::jack_bufsize_callback (nframes_t nframes)
401 _buffer_size = nframes;
402 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
403 last_monitor_check = 0;
405 boost::shared_ptr<Ports> p = ports.reader();
407 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
412 session->set_block_size (_buffer_size);
419 AudioEngine::stop_metering_thread ()
421 if (m_meter_thread) {
422 g_atomic_int_set (&m_meter_exit, 1);
423 m_meter_thread->join ();
429 AudioEngine::start_metering_thread ()
431 if (m_meter_thread == 0) {
432 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread),
433 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
438 AudioEngine::meter_thread ()
441 Glib::usleep (10000); /* 1/100th sec interval */
442 if (g_atomic_int_get(&m_meter_exit)) {
445 IO::update_meters ();
450 AudioEngine::set_session (Session *s)
452 Glib::Mutex::Lock pl (_process_lock);
458 nframes_t blocksize = jack_get_buffer_size (_jack);
460 /* page in as much of the session process code as we
461 can before we really start running.
464 boost::shared_ptr<Ports> p = ports.reader();
466 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
467 (*i)->cycle_start (blocksize);
469 s->process (blocksize);
470 s->process (blocksize);
471 s->process (blocksize);
472 s->process (blocksize);
473 s->process (blocksize);
474 s->process (blocksize);
475 s->process (blocksize);
476 s->process (blocksize);
478 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
485 AudioEngine::remove_session ()
487 Glib::Mutex::Lock lm (_process_lock);
492 session_remove_pending = true;
493 session_removed.wait(_process_lock);
504 AudioEngine::register_input_port (DataType type, const string& portname)
508 fatal << _("register input port called before engine was started") << endmsg;
515 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
521 if (type == DataType::AUDIO)
522 newport = new AudioPort (p);
523 else if (type == DataType::MIDI)
524 newport = new MidiPort (p);
526 throw unknown_type();
529 RCUWriter<Ports> writer (ports);
530 boost::shared_ptr<Ports> ps = writer.get_copy ();
531 ps->insert (ps->begin(), newport);
532 /* writer goes out of scope, forces update */
538 throw PortRegistrationFailure();
545 AudioEngine::register_output_port (DataType type, const string& portname)
549 fatal << _("register output port called before engine was started") << endmsg;
558 if ((p = jack_port_register (_jack, portname.c_str(),
559 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
563 if (type == DataType::AUDIO)
564 newport = new AudioPort (p);
565 else if (type == DataType::MIDI)
566 newport = new MidiPort (p);
568 throw unknown_type ();
571 RCUWriter<Ports> writer (ports);
572 boost::shared_ptr<Ports> ps = writer.get_copy ();
573 ps->insert (ps->begin(), newport);
574 /* writer goes out of scope, forces update */
580 throw PortRegistrationFailure ();
588 AudioEngine::unregister_port (Port& port)
591 /* probably happening when the engine has been halted by JACK,
592 in which case, there is nothing we can do here.
597 int ret = jack_port_unregister (_jack, port._port);
603 RCUWriter<Ports> writer (ports);
604 boost::shared_ptr<Ports> ps = writer.get_copy ();
606 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
613 /* writer goes out of scope, forces update */
616 remove_connections_for (port);
623 AudioEngine::connect (const string& source, const string& destination)
627 fatal << _("connect called before engine was started") << endmsg;
634 string s = make_port_name_non_relative (source);
635 string d = make_port_name_non_relative (destination);
637 int ret = jack_connect (_jack, s.c_str(), d.c_str());
640 pair<string,string> c (s, d);
641 port_connections.push_back (c);
642 } else if (ret == EEXIST) {
643 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
644 source, s, destination, d)
647 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
648 source, s, destination, d)
656 AudioEngine::disconnect (const string& source, const string& destination)
660 fatal << _("disconnect called before engine was started") << endmsg;
667 string s = make_port_name_non_relative (source);
668 string d = make_port_name_non_relative (destination);
670 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
673 pair<string,string> c (s, d);
674 PortConnections::iterator i;
676 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
677 port_connections.erase (i);
685 AudioEngine::disconnect (Port& port)
689 fatal << _("disconnect called before engine was started") << endmsg;
696 int ret = jack_port_disconnect (_jack, port._port);
699 remove_connections_for (port);
707 AudioEngine::frame_rate ()
710 if (_frame_rate == 0) {
711 return (_frame_rate = jack_get_sample_rate (_jack));
716 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
724 AudioEngine::frames_per_cycle ()
727 if (_buffer_size == 0) {
728 return (_buffer_size = jack_get_buffer_size (_jack));
733 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
740 /** Get a port by name.
741 * Note this can return NULL, it will NOT create a port if it is not found (any more).
744 AudioEngine::get_port_by_name (const string& portname, bool keep)
746 Glib::Mutex::Lock lm (_process_lock);
750 fatal << _("get_port_by_name() called before engine was started") << endmsg;
757 boost::shared_ptr<Ports> pr = ports.reader();
759 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
760 if (portname == (*i)->name()) {
769 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
773 fatal << _("get_ports called before engine was started") << endmsg;
779 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
783 AudioEngine::halted (void *arg)
785 AudioEngine* ae = static_cast<AudioEngine *> (arg);
787 ae->_running = false;
788 ae->_buffer_size = 0;
792 ae->Halted(); /* EMIT SIGNAL */
796 AudioEngine::n_physical_outputs () const
805 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
810 for (i = 0; ports[i]; ++i);
817 AudioEngine::n_physical_inputs () const
826 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
831 for (i = 0; ports[i]; ++i);
838 AudioEngine::get_physical_inputs (vector<string>& ins)
847 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
852 for (i = 0; ports[i]; ++i) {
853 ins.push_back (ports[i]);
860 AudioEngine::get_physical_outputs (vector<string>& outs)
869 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
874 for (i = 0; ports[i]; ++i) {
875 outs.push_back (ports[i]);
882 AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
888 assert(type != DataType::NIL);
890 if (!_running || !_jack) {
892 fatal << _("get_nth_physical called before engine was started") << endmsg;
899 ports = jack_get_ports (_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag);
905 for (i = 0; i < n && ports[i]; ++i);
911 free ((char *) ports);
917 AudioEngine::get_port_total_latency (const Port& port)
920 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
926 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
931 return jack_port_get_total_latency (_jack, port._port);
936 AudioEngine::update_total_latency (const Port& port)
939 fatal << _("update_total_latency() called with no JACK client connection") << endmsg;
945 fatal << _("update_total_latency() called before engine was started") << endmsg;
950 #ifdef HAVE_JACK_RECOMPUTE_LATENCY
951 jack_recompute_total_latency (_jack, port._port);
956 AudioEngine::transport_stop ()
958 // cerr << "tell JACK to stop\n";
960 jack_transport_stop (_jack);
965 AudioEngine::transport_start ()
967 // cerr << "tell JACK to start\n";
969 jack_transport_start (_jack);
974 AudioEngine::transport_locate (nframes_t where)
976 // cerr << "tell JACK to locate to " << where << endl;
978 jack_transport_locate (_jack, where);
982 AudioEngine::TransportState
983 AudioEngine::transport_state ()
987 return (TransportState) jack_transport_query (_jack, &pos);
989 return (TransportState) JackTransportStopped;
994 AudioEngine::reset_timebase ()
997 if (Config->get_jack_time_master()) {
998 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1000 return jack_release_timebase (_jack);
1008 AudioEngine::freewheel (bool onoff)
1013 _freewheel_thread_registered = false;
1016 return jack_set_freewheel (_jack, onoff);
1024 AudioEngine::remove_all_ports ()
1026 /* process lock MUST be held */
1029 boost::shared_ptr<Ports> p = ports.reader();
1031 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1032 jack_port_unregister (_jack, (*i)->_port);
1037 RCUWriter<Ports> writer (ports);
1038 boost::shared_ptr<Ports> ps = writer.get_copy ();
1042 port_connections.clear ();
1046 AudioEngine::remove_connections_for (Port& port)
1048 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1049 PortConnections::iterator tmp;
1054 if ((*i).first == port.name()) {
1055 port_connections.erase (i);
1062 #ifdef HAVE_JACK_CLIENT_OPEN
1065 AudioEngine::connect_to_jack (string client_name)
1067 jack_options_t options = JackNullOption;
1068 jack_status_t status;
1069 const char *server_name = NULL;
1071 jack_client_name = client_name; /* might be reset below */
1073 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1075 if (_jack == NULL) {
1077 if (status & JackServerFailed) {
1078 error << _("Unable to connect to JACK server") << endmsg;
1081 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
1085 if (status & JackServerStarted) {
1086 info << _("JACK server started") << endmsg;
1089 if (status & JackNameNotUnique) {
1090 jack_client_name = jack_get_client_name (_jack);
1093 jack_set_error_function (ardour_jack_error);
1101 AudioEngine::connect_to_jack (string client_name)
1103 jack_client_name = client_name;
1105 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1112 #endif /* HAVE_JACK_CLIENT_OPEN */
1115 AudioEngine::disconnect_from_jack ()
1121 jack_client_close (_jack);
1128 Stopped(); /* EMIT SIGNAL */
1136 AudioEngine::reconnect_to_jack ()
1139 disconnect_from_jack ();
1140 /* XXX give jackd a chance */
1141 Glib::usleep (250000);
1144 if (connect_to_jack (jack_client_name)) {
1145 error << _("failed to connect to JACK") << endmsg;
1151 boost::shared_ptr<Ports> p = ports.reader ();
1153 for (i = p->begin(); i != p->end(); ++i) {
1155 /* XXX hack hack hack */
1157 string long_name = (*i)->name();
1160 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1162 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type().to_jack_type(), (*i)->flags(), 0)) == 0) {
1163 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1170 if ((*i)->flags() & JackPortIsOutput) {
1171 (*i)->get_buffer().silence (jack_get_buffer_size (_jack), 0);
1175 if (i != p->end()) {
1177 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1178 jack_port_unregister (_jack, (*i)->_port);
1185 session->reset_jack_connection (_jack);
1186 nframes_t blocksize = jack_get_buffer_size (_jack);
1187 session->set_block_size (blocksize);
1188 session->set_frame_rate (jack_get_sample_rate (_jack));
1191 last_monitor_check = 0;
1193 jack_on_shutdown (_jack, halted, this);
1194 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1195 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1196 jack_set_process_callback (_jack, _process_callback, this);
1197 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1198 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1199 jack_set_xrun_callback (_jack, _xrun_callback, this);
1200 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1201 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1203 if (Config->get_jack_time_master()) {
1204 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1207 if (jack_activate (_jack) == 0) {
1214 /* re-establish connections */
1216 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1220 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1221 if (err != EEXIST) {
1222 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1223 (*i).first, (*i).second, err)
1229 Running (); /* EMIT SIGNAL*/
1235 AudioEngine::request_buffer_size (nframes_t nframes)
1239 if (nframes == jack_get_buffer_size (_jack)) {
1243 return jack_set_buffer_size (_jack, nframes);
1251 AudioEngine::update_total_latencies ()
1253 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1254 jack_recompute_total_latencies (_jack);
1259 AudioEngine::make_port_name_relative (string portname)
1261 string::size_type len;
1262 string::size_type n;
1264 len = portname.length();
1266 for (n = 0; n < len; ++n) {
1267 if (portname[n] == ':') {
1272 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1273 return portname.substr (n+1);
1280 AudioEngine::make_port_name_non_relative (string portname)
1284 if (portname.find_first_of (':') != string::npos) {
1288 str = jack_client_name;
1296 AudioEngine::is_realtime () const
1299 return jack_is_realtime (_jack);