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 */
259 AudioEngine::_process_callback (nframes_t nframes, void *arg)
261 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
265 AudioEngine::_freewheel_callback (int onoff, void *arg)
267 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
271 AudioEngine::process_callback (nframes_t nframes)
273 // CycleTimer ct ("AudioEngine::process");
274 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
275 nframes_t next_processed_frames;
277 /* handle wrap around of total frames counter */
279 if (max_frames - _processed_frames < nframes) {
280 next_processed_frames = nframes - (max_frames - _processed_frames);
282 next_processed_frames = _processed_frames + nframes;
285 if (!tm.locked() || session == 0) {
286 _processed_frames = next_processed_frames;
290 if (session_remove_pending) {
292 session_remove_pending = false;
293 session_removed.signal();
294 _processed_frames = next_processed_frames;
299 if (Freewheel (nframes)) {
300 cerr << "Freewheeling returned non-zero!\n";
301 _freewheeling = false;
302 jack_set_freewheel (_jack, false);
307 boost::shared_ptr<Ports> p = ports.reader();
309 // Prepare ports (ie read data if necessary)
310 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
311 (*i)->cycle_start (nframes);
315 session->process (nframes);
319 _processed_frames = next_processed_frames;
323 // Finalize ports (ie write data if necessary)
324 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
328 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
330 boost::shared_ptr<Ports> p = ports.reader();
332 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
337 if (port->_last_monitor != (x = port->monitoring_input ())) {
338 port->_last_monitor = x;
339 /* XXX I think this is dangerous, due to
340 a likely mutex in the signal handlers ...
342 port->MonitorInputChanged (x); /* EMIT SIGNAL */
345 last_monitor_check = next_processed_frames;
348 _processed_frames = next_processed_frames;
353 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
355 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
359 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
361 _frame_rate = nframes;
362 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
364 /* check for monitor input change every 1/10th of second */
366 monitor_check_interval = nframes / 10;
367 last_monitor_check = 0;
370 session->set_frame_rate (nframes);
373 SampleRateChanged (nframes); /* EMIT SIGNAL */
379 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
381 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
385 AudioEngine::jack_bufsize_callback (nframes_t nframes)
387 _buffer_size = nframes;
388 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
389 last_monitor_check = 0;
391 boost::shared_ptr<Ports> p = ports.reader();
393 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
398 session->set_block_size (_buffer_size);
405 AudioEngine::stop_metering_thread ()
407 if (m_meter_thread) {
408 g_atomic_int_set (&m_meter_exit, 1);
409 m_meter_thread->join ();
415 AudioEngine::start_metering_thread ()
417 if (m_meter_thread == 0) {
418 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread),
419 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
424 AudioEngine::meter_thread ()
427 Glib::usleep (10000); /* 1/100th sec interval */
428 if (g_atomic_int_get(&m_meter_exit)) {
431 IO::update_meters ();
436 AudioEngine::set_session (Session *s)
438 Glib::Mutex::Lock pl (_process_lock);
444 nframes_t blocksize = jack_get_buffer_size (_jack);
446 /* page in as much of the session process code as we
447 can before we really start running.
450 boost::shared_ptr<Ports> p = ports.reader();
452 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
453 (*i)->cycle_start (blocksize);
455 s->process (blocksize);
456 s->process (blocksize);
457 s->process (blocksize);
458 s->process (blocksize);
459 s->process (blocksize);
460 s->process (blocksize);
461 s->process (blocksize);
462 s->process (blocksize);
464 for (Ports::iterator i = p->begin(); i != p->end(); ++i)
471 AudioEngine::remove_session ()
473 Glib::Mutex::Lock lm (_process_lock);
478 session_remove_pending = true;
479 session_removed.wait(_process_lock);
490 AudioEngine::register_input_port (DataType type, const string& portname)
494 fatal << _("register input port called before engine was started") << endmsg;
501 jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
507 if (type == DataType::AUDIO)
508 newport = new AudioPort (p);
509 else if (type == DataType::MIDI)
510 newport = new MidiPort (p);
512 throw unknown_type();
515 RCUWriter<Ports> writer (ports);
516 boost::shared_ptr<Ports> ps = writer.get_copy ();
517 ps->insert (ps->begin(), newport);
518 /* writer goes out of scope, forces update */
524 throw PortRegistrationFailure();
531 AudioEngine::register_output_port (DataType type, const string& portname)
535 fatal << _("register output port called before engine was started") << endmsg;
544 if ((p = jack_port_register (_jack, portname.c_str(),
545 type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
549 if (type == DataType::AUDIO)
550 newport = new AudioPort (p);
551 else if (type == DataType::MIDI)
552 newport = new MidiPort (p);
554 throw unknown_type ();
557 RCUWriter<Ports> writer (ports);
558 boost::shared_ptr<Ports> ps = writer.get_copy ();
559 ps->insert (ps->begin(), newport);
560 /* writer goes out of scope, forces update */
566 throw PortRegistrationFailure ();
574 AudioEngine::unregister_port (Port& port)
577 /* probably happening when the engine has been halted by JACK,
578 in which case, there is nothing we can do here.
583 int ret = jack_port_unregister (_jack, port._port);
589 RCUWriter<Ports> writer (ports);
590 boost::shared_ptr<Ports> ps = writer.get_copy ();
592 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
599 /* writer goes out of scope, forces update */
602 remove_connections_for (port);
609 AudioEngine::connect (const string& source, const string& destination)
613 fatal << _("connect called before engine was started") << endmsg;
620 string s = make_port_name_non_relative (source);
621 string d = make_port_name_non_relative (destination);
623 int ret = jack_connect (_jack, s.c_str(), d.c_str());
626 pair<string,string> c (s, d);
627 port_connections.push_back (c);
628 } else if (ret == EEXIST) {
629 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
630 source, s, destination, d)
633 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
634 source, s, destination, d)
642 AudioEngine::disconnect (const string& source, const string& destination)
646 fatal << _("disconnect called before engine was started") << endmsg;
653 string s = make_port_name_non_relative (source);
654 string d = make_port_name_non_relative (destination);
656 int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
659 pair<string,string> c (s, d);
660 PortConnections::iterator i;
662 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
663 port_connections.erase (i);
671 AudioEngine::disconnect (Port& port)
675 fatal << _("disconnect called before engine was started") << endmsg;
682 int ret = jack_port_disconnect (_jack, port._port);
685 remove_connections_for (port);
693 AudioEngine::frame_rate ()
696 if (_frame_rate == 0) {
697 return (_frame_rate = jack_get_sample_rate (_jack));
702 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
710 AudioEngine::frames_per_cycle ()
713 if (_buffer_size == 0) {
714 return (_buffer_size = jack_get_buffer_size (_jack));
719 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
726 /** Get a port by name.
727 * Note this can return NULL, it will NOT create a port if it is not found (any more).
730 AudioEngine::get_port_by_name (const string& portname, bool keep)
732 Glib::Mutex::Lock lm (_process_lock);
736 fatal << _("get_port_by_name() called before engine was started") << endmsg;
743 boost::shared_ptr<Ports> pr = ports.reader();
745 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
746 if (portname == (*i)->name()) {
755 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
759 fatal << _("get_ports called before engine was started") << endmsg;
765 return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
769 AudioEngine::halted (void *arg)
771 AudioEngine* ae = static_cast<AudioEngine *> (arg);
773 ae->_running = false;
774 ae->_buffer_size = 0;
778 ae->Halted(); /* EMIT SIGNAL */
782 AudioEngine::n_physical_outputs () const
791 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
796 for (i = 0; ports[i]; ++i);
803 AudioEngine::n_physical_inputs () const
812 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
817 for (i = 0; ports[i]; ++i);
824 AudioEngine::get_physical_inputs (vector<string>& ins)
833 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
838 for (i = 0; ports[i]; ++i) {
839 ins.push_back (ports[i]);
846 AudioEngine::get_physical_outputs (vector<string>& outs)
855 if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
860 for (i = 0; ports[i]; ++i) {
861 outs.push_back (ports[i]);
868 AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
874 assert(type != DataType::NIL);
876 if (!_running || !_jack) {
878 fatal << _("get_nth_physical called before engine was started") << endmsg;
885 ports = jack_get_ports (_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag);
891 for (i = 0; i < n && ports[i]; ++i);
897 free ((char *) ports);
903 AudioEngine::get_port_total_latency (const Port& port)
906 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
912 fatal << _("get_port_total_latency() called before engine was started") << endmsg;
917 return jack_port_get_total_latency (_jack, port._port);
921 AudioEngine::transport_stop ()
923 // cerr << "tell JACK to stop\n";
925 jack_transport_stop (_jack);
930 AudioEngine::transport_start ()
932 // cerr << "tell JACK to start\n";
934 jack_transport_start (_jack);
939 AudioEngine::transport_locate (nframes_t where)
941 // cerr << "tell JACK to locate to " << where << endl;
943 jack_transport_locate (_jack, where);
947 AudioEngine::TransportState
948 AudioEngine::transport_state ()
952 return (TransportState) jack_transport_query (_jack, &pos);
954 return (TransportState) JackTransportStopped;
959 AudioEngine::reset_timebase ()
962 if (Config->get_jack_time_master()) {
963 return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
965 return jack_release_timebase (_jack);
973 AudioEngine::freewheel (bool onoff)
978 _freewheel_thread_registered = false;
981 return jack_set_freewheel (_jack, onoff);
989 AudioEngine::remove_all_ports ()
991 /* process lock MUST be held */
994 boost::shared_ptr<Ports> p = ports.reader();
996 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
997 jack_port_unregister (_jack, (*i)->_port);
1002 RCUWriter<Ports> writer (ports);
1003 boost::shared_ptr<Ports> ps = writer.get_copy ();
1007 port_connections.clear ();
1011 AudioEngine::remove_connections_for (Port& port)
1013 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1014 PortConnections::iterator tmp;
1019 if ((*i).first == port.name()) {
1020 port_connections.erase (i);
1027 #ifdef HAVE_JACK_CLIENT_OPEN
1030 AudioEngine::connect_to_jack (string client_name)
1032 jack_options_t options = JackNullOption;
1033 jack_status_t status;
1034 const char *server_name = NULL;
1036 jack_client_name = client_name; /* might be reset below */
1038 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1040 if (_jack == NULL) {
1042 if (status & JackServerFailed) {
1043 error << _("Unable to connect to JACK server") << endmsg;
1046 error << string_compose (_("Could not connect to JACK server as \"%1\""), jack_client_name) << endmsg;
1050 if (status & JackServerStarted) {
1051 info << _("JACK server started") << endmsg;
1054 if (status & JackNameNotUnique) {
1055 jack_client_name = jack_get_client_name (_jack);
1058 jack_set_error_function (ardour_jack_error);
1066 AudioEngine::connect_to_jack (string client_name)
1068 jack_client_name = client_name;
1070 if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1077 #endif /* HAVE_JACK_CLIENT_OPEN */
1080 AudioEngine::disconnect_from_jack ()
1086 jack_client_close (_jack);
1093 Stopped(); /* EMIT SIGNAL */
1101 AudioEngine::reconnect_to_jack ()
1104 disconnect_from_jack ();
1105 /* XXX give jackd a chance */
1106 Glib::usleep (250000);
1109 if (connect_to_jack (jack_client_name)) {
1110 error << _("failed to connect to JACK") << endmsg;
1116 boost::shared_ptr<Ports> p = ports.reader ();
1118 for (i = p->begin(); i != p->end(); ++i) {
1120 /* XXX hack hack hack */
1122 string long_name = (*i)->name();
1125 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1127 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type().to_jack_type(), (*i)->flags(), 0)) == 0) {
1128 error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1135 if ((*i)->flags() & JackPortIsOutput) {
1136 (*i)->get_buffer().silence (jack_get_buffer_size (_jack), 0);
1140 if (i != p->end()) {
1142 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1143 jack_port_unregister (_jack, (*i)->_port);
1150 session->reset_jack_connection (_jack);
1151 nframes_t blocksize = jack_get_buffer_size (_jack);
1152 session->set_block_size (blocksize);
1153 session->set_frame_rate (jack_get_sample_rate (_jack));
1156 last_monitor_check = 0;
1158 jack_on_shutdown (_jack, halted, this);
1159 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1160 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1161 jack_set_process_callback (_jack, _process_callback, this);
1162 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1163 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1164 jack_set_xrun_callback (_jack, _xrun_callback, this);
1165 jack_set_sync_callback (_jack, _jack_sync_callback, this);
1166 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1168 if (Config->get_jack_time_master()) {
1169 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1172 if (jack_activate (_jack) == 0) {
1179 /* re-establish connections */
1181 for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1185 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1186 if (err != EEXIST) {
1187 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1188 (*i).first, (*i).second, err)
1194 Running (); /* EMIT SIGNAL*/
1200 AudioEngine::request_buffer_size (nframes_t nframes)
1204 if (nframes == jack_get_buffer_size (_jack)) {
1208 return jack_set_buffer_size (_jack, nframes);
1216 AudioEngine::update_total_latencies ()
1218 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1219 jack_recompute_total_latencies (_jack);
1224 AudioEngine::make_port_name_relative (string portname)
1226 string::size_type len;
1227 string::size_type n;
1229 len = portname.length();
1231 for (n = 0; n < len; ++n) {
1232 if (portname[n] == ':') {
1237 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1238 return portname.substr (n+1);
1245 AudioEngine::make_port_name_non_relative (string portname)
1249 if (portname.find_first_of (':') != string::npos) {
1253 str = jack_client_name;
1261 AudioEngine::is_realtime () const
1264 return jack_is_realtime (_jack);