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.
27 #include <glibmm/timer.h>
28 #include <jack/jack.h>
29 #include <jack/thread.h>
31 #include "pbd/pthread_utils.h"
32 #include "pbd/stacktrace.h"
33 #include "pbd/unknown_type.h"
36 #include "midi++/port.h"
37 #include "midi++/mmc.h"
38 #include "midi++/manager.h"
40 #include "ardour/amp.h"
41 #include "ardour/audio_port.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/buffer.h"
44 #include "ardour/buffer_set.h"
45 #include "ardour/cycle_timer.h"
46 #include "ardour/delivery.h"
47 #include "ardour/event_type_map.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/io.h"
50 #include "ardour/meter.h"
51 #include "ardour/midi_port.h"
52 #include "ardour/process_thread.h"
53 #include "ardour/port.h"
54 #include "ardour/port_set.h"
55 #include "ardour/session.h"
56 #include "ardour/timestamps.h"
57 #include "ardour/utils.h"
62 using namespace ARDOUR;
65 gint AudioEngine::m_meter_exit;
66 AudioEngine* AudioEngine::_instance = 0;
68 #define GET_PRIVATE_JACK_POINTER(j) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; }
69 #define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; }
71 AudioEngine::AudioEngine (string client_name, string session_uuid)
74 _instance = this; /* singleton */
76 session_remove_pending = false;
79 last_monitor_check = 0;
80 monitor_check_interval = INT32_MAX;
81 _processed_frames = 0;
86 _freewheeling = false;
90 g_atomic_int_set (&m_meter_exit, 0);
92 if (connect_to_jack (client_name, session_uuid)) {
93 throw NoBackendAvailable ();
96 Port::set_engine (this);
98 // Initialize parameter metadata (e.g. ranges)
99 Evoral::Parameter p(NullAutomation);
100 p = EventTypeMap::instance().new_parameter(NullAutomation);
101 p = EventTypeMap::instance().new_parameter(GainAutomation);
102 p = EventTypeMap::instance().new_parameter(PanAzimuthAutomation);
103 p = EventTypeMap::instance().new_parameter(PanElevationAutomation);
104 p = EventTypeMap::instance().new_parameter(PanWidthAutomation);
105 p = EventTypeMap::instance().new_parameter(PluginAutomation);
106 p = EventTypeMap::instance().new_parameter(SoloAutomation);
107 p = EventTypeMap::instance().new_parameter(MuteAutomation);
108 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
109 p = EventTypeMap::instance().new_parameter(MidiPgmChangeAutomation);
110 p = EventTypeMap::instance().new_parameter(MidiPitchBenderAutomation);
111 p = EventTypeMap::instance().new_parameter(MidiChannelPressureAutomation);
112 p = EventTypeMap::instance().new_parameter(FadeInAutomation);
113 p = EventTypeMap::instance().new_parameter(FadeOutAutomation);
114 p = EventTypeMap::instance().new_parameter(EnvelopeAutomation);
115 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
118 AudioEngine::~AudioEngine ()
121 Glib::Mutex::Lock tm (_process_lock);
122 session_removed.signal ();
125 jack_client_close (_jack);
129 stop_metering_thread ();
134 AudioEngine::jack() const
140 _thread_init_callback (void * /*arg*/)
142 /* make sure that anybody who needs to know about this thread
146 pthread_set_name (X_("audioengine"));
148 PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
149 PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
151 SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
153 MIDI::Port::set_process_thread (pthread_self());
156 typedef void (*_JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);
158 static void (*on_info_shutdown)(jack_client_t*, _JackInfoShutdownCallback, void *);
159 extern void jack_on_info_shutdown (jack_client_t*, _JackInfoShutdownCallback, void *) __attribute__((weak));
161 static void check_jack_symbols () __attribute__((constructor));
163 void check_jack_symbols ()
165 /* use weak linking to see if we really have various late-model JACK function */
166 on_info_shutdown = jack_on_info_shutdown;
170 ardour_jack_error (const char* msg)
172 error << "JACK: " << msg << endmsg;
176 AudioEngine::start ()
178 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
182 pframes_t blocksize = jack_get_buffer_size (_priv_jack);
185 BootMessage (_("Connect session to engine"));
187 _session->set_block_size (blocksize);
188 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
190 /* page in as much of the session process code as we
191 can before we really start running.
194 _session->process (blocksize);
195 _session->process (blocksize);
196 _session->process (blocksize);
197 _session->process (blocksize);
198 _session->process (blocksize);
199 _session->process (blocksize);
200 _session->process (blocksize);
201 _session->process (blocksize);
204 _processed_frames = 0;
205 last_monitor_check = 0;
207 if (on_info_shutdown) {
208 jack_on_info_shutdown (_priv_jack, halted_info, this);
210 jack_on_shutdown (_priv_jack, halted, this);
212 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
213 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
214 // jack_set_process_callback (_priv_jack, _process_callback, this);
215 jack_set_process_thread (_priv_jack, _process_thread, this);
216 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
217 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
218 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
219 #ifdef HAVE_JACK_SESSION
220 if( jack_set_session_callback )
221 jack_set_session_callback (_priv_jack, _session_callback, this);
223 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
224 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
225 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
226 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
228 if (_session && _session->config.get_jack_time_master()) {
229 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
232 jack_set_error_function (ardour_jack_error);
234 if (jack_activate (_priv_jack) == 0) {
237 Running(); /* EMIT SIGNAL */
239 // error << _("cannot activate JACK client") << endmsg;
242 _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
244 jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
246 error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
248 _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
249 jack_port_unregister (_priv_jack, midi_port);
253 return _running ? 0 : -1;
257 AudioEngine::stop (bool forever)
259 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
263 disconnect_from_jack ();
265 jack_deactivate (_priv_jack);
266 Stopped(); /* EMIT SIGNAL */
267 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
272 stop_metering_thread ();
275 return _running ? -1 : 0;
280 AudioEngine::get_sync_offset (pframes_t& offset) const
283 #ifdef HAVE_JACK_VIDEO_SUPPORT
285 GET_PRIVATE_JACK_POINTER_RET (_jack, false);
290 (void) jack_transport_query (_priv_jack, &pos);
292 if (pos.valid & JackVideoFrameOffset) {
293 offset = pos.video_offset;
306 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
307 jack_position_t* pos, int new_position, void *arg)
309 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
313 AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
314 jack_position_t* pos, int new_position)
316 if (_jack && _session && _session->synced_to_jack()) {
317 _session->jack_timebase_callback (state, nframes, pos, new_position);
322 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
324 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
328 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
330 if (_jack && _session) {
331 return _session->jack_sync_callback (state, pos);
338 AudioEngine::_xrun_callback (void *arg)
340 AudioEngine* ae = static_cast<AudioEngine*> (arg);
341 if (ae->connected()) {
342 ae->Xrun (); /* EMIT SIGNAL */
347 #ifdef HAVE_JACK_SESSION
349 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
351 printf( "helo.... " );
352 AudioEngine* ae = static_cast<AudioEngine*> (arg);
353 if (ae->connected()) {
354 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
359 AudioEngine::_graph_order_callback (void *arg)
361 AudioEngine* ae = static_cast<AudioEngine*> (arg);
362 if (ae->connected()) {
363 ae->GraphReordered (); /* EMIT SIGNAL */
368 /** Wrapped which is called by JACK as its process callback. It is just
369 * here to get us back into C++ land by calling AudioEngine::process_callback()
370 * @param nframes Number of frames passed by JACK.
371 * @param arg User argument passed by JACK, which will be the AudioEngine*.
374 AudioEngine::_process_callback (pframes_t nframes, void *arg)
376 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
380 AudioEngine::_process_thread (void *arg)
382 return static_cast<AudioEngine *> (arg)->process_thread ();
386 AudioEngine::_freewheel_callback (int onoff, void *arg)
388 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
392 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
394 AudioEngine* ae = static_cast<AudioEngine*> (arg);
395 ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
399 AudioEngine::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg)
401 AudioEngine* ae = static_cast<AudioEngine*> (arg);
403 GET_PRIVATE_JACK_POINTER (ae->_jack);
405 jack_port_t* jack_port_a = jack_port_by_id (_priv_jack, id_a);
406 jack_port_t* jack_port_b = jack_port_by_id (_priv_jack, id_b);
411 boost::shared_ptr<Ports> pr = ae->ports.reader ();
412 Ports::iterator i = pr->begin ();
413 while (i != pr->end() && (port_a == 0 || port_b == 0)) {
414 if (jack_port_a == (*i)->_jack_port) {
416 } else if (jack_port_b == (*i)->_jack_port) {
422 ae->PortConnectedOrDisconnected (port_a, port_b, conn == 0 ? false : true); /* EMIT SIGNAL */
426 AudioEngine::split_cycle (pframes_t offset)
428 /* caller must hold process lock */
430 AudioPort::increment_port_offset (offset);
432 /* tell all Ports that we're going to start a new (split) cycle */
434 boost::shared_ptr<Ports> p = ports.reader();
436 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
437 (*i)->cycle_split ();
442 AudioEngine::finish_process_cycle (int /* status*/ )
444 GET_PRIVATE_JACK_POINTER(_jack);
445 jack_cycle_signal (_jack, 0);
449 AudioEngine::process_thread ()
451 /* JACK doesn't do this for us when we use the wait API
454 _thread_init_callback (0);
456 _main_thread = new ProcessThread;
459 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
460 pframes_t nframes = jack_cycle_wait (_jack);
462 if (process_callback (nframes)) {
463 cerr << "--- process\n";
467 finish_process_cycle (0);
473 /** Method called by JACK (via _process_callback) which says that there
474 * is work to be done.
475 * @param nframes Number of frames to process.
478 AudioEngine::process_callback (pframes_t nframes)
480 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
481 // CycleTimer ct ("AudioEngine::process");
482 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
484 /// The number of frames that will have been processed when we've finished
485 pframes_t next_processed_frames;
487 /* handle wrap around of total frames counter */
489 if (max_framepos - _processed_frames < nframes) {
490 next_processed_frames = nframes - (max_framepos - _processed_frames);
492 next_processed_frames = _processed_frames + nframes;
495 if (!tm.locked() || _session == 0) {
496 /* return having done nothing */
497 _processed_frames = next_processed_frames;
501 if (session_remove_pending) {
502 /* perform the actual session removal */
504 session_remove_pending = false;
505 session_removed.signal();
506 _processed_frames = next_processed_frames;
510 /* tell all relevant objects that we're starting a new cycle */
512 Delivery::CycleStart (nframes);
513 AudioPort::set_port_offset (0);
514 InternalReturn::CycleStart (nframes);
516 /* tell all Ports that we're starting a new cycle */
518 boost::shared_ptr<Ports> p = ports.reader();
520 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
521 (*i)->cycle_start (nframes);
524 /* test if we are freewheeling and there are freewheel signals connected.
525 ardour should act normally even when freewheeling unless /it/ is exporting */
528 if (_freewheeling && !Freewheel.empty()) {
529 /* emit the Freewheel signal and stop freewheeling in the event of trouble
531 boost::optional<int> r = Freewheel (nframes);
532 if (r.get_value_or (0)) {
533 jack_set_freewheel (_priv_jack, false);
538 _session->process (nframes);
548 _processed_frames = next_processed_frames;
552 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
554 boost::shared_ptr<Ports> p = ports.reader();
556 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
561 if (port->_last_monitor != (x = port->monitoring_input ())) {
562 port->_last_monitor = x;
563 /* XXX I think this is dangerous, due to
564 a likely mutex in the signal handlers ...
566 port->MonitorInputChanged (x); /* EMIT SIGNAL */
569 last_monitor_check = next_processed_frames;
572 if (_session->silent()) {
574 boost::shared_ptr<Ports> p = ports.reader();
576 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
580 if (port->sends_output()) {
581 port->get_buffer(nframes).silence(nframes);
588 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
589 (*i)->cycle_end (nframes);
592 _processed_frames = next_processed_frames;
597 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
599 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
603 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
605 _frame_rate = nframes;
606 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
608 /* check for monitor input change every 1/10th of second */
610 monitor_check_interval = nframes / 10;
611 last_monitor_check = 0;
614 _session->set_frame_rate (nframes);
617 SampleRateChanged (nframes); /* EMIT SIGNAL */
623 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
625 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
629 AudioEngine::jack_bufsize_callback (pframes_t nframes)
631 bool need_midi_size = true;
632 bool need_audio_size = true;
634 _buffer_size = nframes;
635 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
636 last_monitor_check = 0;
638 boost::shared_ptr<Ports> p = ports.reader();
640 /* crude guesses, see below where we try to get the right answers.
642 Note that our guess for MIDI deliberatey tries to overestimate
643 by a little. It would be nicer if we could get the actual
644 size from a port, but we have to use this estimate in the
645 event that there are no MIDI ports currently. If there are
646 the value will be adjusted below.
649 _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
650 _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
652 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
654 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
655 _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
656 need_audio_size = false;
660 if (need_midi_size && (*i)->type() == DataType::MIDI) {
661 _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
662 need_midi_size = false;
669 _session->set_block_size (_buffer_size);
676 AudioEngine::stop_metering_thread ()
678 if (m_meter_thread) {
679 g_atomic_int_set (&m_meter_exit, 1);
680 m_meter_thread->join ();
686 AudioEngine::start_metering_thread ()
688 if (m_meter_thread == 0) {
689 g_atomic_int_set (&m_meter_exit, 0);
690 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
691 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
696 AudioEngine::meter_thread ()
698 pthread_set_name (X_("meter"));
701 Glib::usleep (10000); /* 1/100th sec interval */
702 if (g_atomic_int_get(&m_meter_exit)) {
710 AudioEngine::set_session (Session *s)
712 Glib::Mutex::Lock pl (_process_lock);
714 SessionHandlePtr::set_session (s);
718 start_metering_thread ();
720 pframes_t blocksize = jack_get_buffer_size (_jack);
722 /* page in as much of the session process code as we
723 can before we really start running.
726 boost::shared_ptr<Ports> p = ports.reader();
728 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
729 (*i)->cycle_start (blocksize);
732 _session->process (blocksize);
733 _session->process (blocksize);
734 _session->process (blocksize);
735 _session->process (blocksize);
736 _session->process (blocksize);
737 _session->process (blocksize);
738 _session->process (blocksize);
739 _session->process (blocksize);
741 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
742 (*i)->cycle_end (blocksize);
748 AudioEngine::remove_session ()
750 Glib::Mutex::Lock lm (_process_lock);
754 stop_metering_thread ();
757 session_remove_pending = true;
758 session_removed.wait(_process_lock);
762 SessionHandlePtr::set_session (0);
769 AudioEngine::port_registration_failure (const std::string& portname)
771 GET_PRIVATE_JACK_POINTER (_jack);
772 string full_portname = jack_client_name;
773 full_portname += ':';
774 full_portname += portname;
777 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
781 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
783 reason = string_compose (_("No more JACK ports are available. You will need to stop %1 and restart JACK with ports if you need this many tracks."), PROGRAM_NAME);
786 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
790 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
795 if (dtype == DataType::AUDIO) {
796 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
797 } else if (dtype == DataType::MIDI) {
798 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
800 throw PortRegistrationFailure("unable to create port (unknown type)");
803 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
804 size_t port_buffer_size = newport->raw_buffer_size(0);
805 if (port_buffer_size > old_buffer_size) {
806 old_buffer_size = port_buffer_size;
809 RCUWriter<Ports> writer (ports);
810 boost::shared_ptr<Ports> ps = writer.get_copy ();
811 ps->insert (ps->begin(), newport);
813 /* writer goes out of scope, forces update */
818 catch (PortRegistrationFailure& err) {
820 } catch (std::exception& e) {
821 throw PortRegistrationFailure(string_compose(
822 _("unable to create port: %1"), e.what()).c_str());
824 throw PortRegistrationFailure("unable to create port (unknown error)");
829 AudioEngine::register_input_port (DataType type, const string& portname)
831 return register_port (type, portname, true);
835 AudioEngine::register_output_port (DataType type, const string& portname)
837 return register_port (type, portname, false);
841 AudioEngine::unregister_port (Port& port)
843 /* caller must hold process lock */
846 /* probably happening when the engine has been halted by JACK,
847 in which case, there is nothing we can do here.
853 RCUWriter<Ports> writer (ports);
854 boost::shared_ptr<Ports> ps = writer.get_copy ();
856 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
864 /* writer goes out of scope, forces update */
871 AudioEngine::connect (const string& source, const string& destination)
877 fatal << _("connect called before engine was started") << endmsg;
884 string s = make_port_name_non_relative (source);
885 string d = make_port_name_non_relative (destination);
888 Port* src = get_port_by_name (s);
889 Port* dst = get_port_by_name (d);
892 ret = src->connect (d);
894 ret = dst->connect (s);
896 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
901 /* already exists - no error, no warning */
902 } else if (ret < 0) {
903 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
904 source, s, destination, d)
912 AudioEngine::disconnect (const string& source, const string& destination)
918 fatal << _("disconnect called before engine was started") << endmsg;
925 string s = make_port_name_non_relative (source);
926 string d = make_port_name_non_relative (destination);
928 Port* src = get_port_by_name (s);
929 Port* dst = get_port_by_name (d);
932 ret = src->disconnect (d);
934 ret = dst->disconnect (s);
936 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
943 AudioEngine::disconnect (Port& port)
945 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
949 fatal << _("disconnect called before engine was started") << endmsg;
956 return port.disconnect_all ();
960 AudioEngine::frame_rate () const
962 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
963 if (_frame_rate == 0) {
964 return (_frame_rate = jack_get_sample_rate (_priv_jack));
971 AudioEngine::raw_buffer_size (DataType t)
973 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
974 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
978 AudioEngine::frames_per_cycle () const
980 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
981 if (_buffer_size == 0) {
982 return (_buffer_size = jack_get_buffer_size (_jack));
988 /** @param name Full or short name of port
989 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
990 * so must not be deleted.
993 AudioEngine::get_port_by_name (const string& portname)
997 fatal << _("get_port_by_name() called before engine was started") << endmsg;
1004 if (portname.find_first_of (':') != string::npos) {
1005 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
1006 /* not an ardour: port */
1011 std::string const rel = make_port_name_relative (portname);
1013 boost::shared_ptr<Ports> pr = ports.reader();
1015 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1016 if (rel == (*i)->name()) {
1025 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1027 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1030 fatal << _("get_ports called before engine was started") << endmsg;
1036 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1040 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1042 /* called from jack shutdown handler */
1044 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1045 bool was_running = ae->_running;
1047 ae->stop_metering_thread ();
1049 ae->_running = false;
1050 ae->_buffer_size = 0;
1051 ae->_frame_rate = 0;
1055 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1057 case JackBackendError:
1058 ae->Halted(reason); /* EMIT SIGNAL */
1061 ae->Halted(""); /* EMIT SIGNAL */
1064 ae->Halted(""); /* EMIT SIGNAL */
1070 AudioEngine::halted (void *arg)
1072 cerr << "HALTED by JACK\n";
1074 /* called from jack shutdown handler */
1076 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1077 bool was_running = ae->_running;
1079 ae->stop_metering_thread ();
1081 ae->_running = false;
1082 ae->_buffer_size = 0;
1083 ae->_frame_rate = 0;
1087 ae->Halted(""); /* EMIT SIGNAL */
1088 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1093 AudioEngine::died ()
1095 /* called from a signal handler for SIGPIPE */
1097 stop_metering_thread ();
1106 AudioEngine::can_request_hardware_monitoring ()
1108 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1109 const char ** ports;
1111 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1121 AudioEngine::n_physical (unsigned long flags) const
1125 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1127 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1132 for (uint32_t i = 0; ports[i]; ++i) {
1133 if (!strstr (ports[i], "Midi-Through")) {
1134 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1135 c.set (t, c.get (t) + 1);
1145 AudioEngine::n_physical_inputs () const
1147 return n_physical (JackPortIsInput);
1151 AudioEngine::n_physical_outputs () const
1153 return n_physical (JackPortIsOutput);
1157 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1159 GET_PRIVATE_JACK_POINTER (_jack);
1160 const char ** ports;
1162 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1167 for (uint32_t i = 0; ports[i]; ++i) {
1168 if (strstr (ports[i], "Midi-Through")) {
1171 phy.push_back (ports[i]);
1177 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1178 * a physical input connector.
1181 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1183 get_physical (type, JackPortIsOutput, ins);
1186 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1187 * a physical output connector.
1190 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1192 get_physical (type, JackPortIsInput, outs);
1196 AudioEngine::update_total_latency (const Port& port)
1198 port.recompute_total_latency ();
1202 AudioEngine::transport_stop ()
1204 GET_PRIVATE_JACK_POINTER (_jack);
1205 jack_transport_stop (_priv_jack);
1209 AudioEngine::transport_start ()
1211 GET_PRIVATE_JACK_POINTER (_jack);
1212 jack_transport_start (_priv_jack);
1216 AudioEngine::transport_locate (framepos_t where)
1218 GET_PRIVATE_JACK_POINTER (_jack);
1219 // cerr << "tell JACK to locate to " << where << endl;
1220 jack_transport_locate (_priv_jack, where);
1223 AudioEngine::TransportState
1224 AudioEngine::transport_state ()
1226 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1227 jack_position_t pos;
1228 return (TransportState) jack_transport_query (_priv_jack, &pos);
1232 AudioEngine::reset_timebase ()
1234 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1236 if (_session->config.get_jack_time_master()) {
1237 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1239 return jack_release_timebase (_jack);
1246 AudioEngine::freewheel (bool onoff)
1248 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1250 if (onoff != _freewheeling) {
1251 return jack_set_freewheel (_priv_jack, onoff);
1254 /* already doing what has been asked for */
1260 AudioEngine::remove_all_ports ()
1262 /* process lock MUST be held */
1265 RCUWriter<Ports> writer (ports);
1266 boost::shared_ptr<Ports> ps = writer.get_copy ();
1268 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1275 /* clear dead wood list too */
1281 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1283 EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
1284 boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
1285 jack_options_t options = JackNullOption;
1286 jack_status_t status;
1287 const char *server_name = NULL;
1289 /* revert all environment settings back to whatever they were when ardour started
1293 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
1294 global_epa->restore ();
1297 jack_client_name = client_name; /* might be reset below */
1298 #ifdef HAVE_JACK_SESSION
1299 if (! session_uuid.empty())
1300 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1303 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1305 if (_jack == NULL) {
1306 // error message is not useful here
1310 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1312 if (status & JackNameNotUnique) {
1313 jack_client_name = jack_get_client_name (_priv_jack);
1320 AudioEngine::disconnect_from_jack ()
1322 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1325 stop_metering_thread ();
1329 Glib::Mutex::Lock lm (_process_lock);
1330 jack_client_close (_priv_jack);
1336 _raw_buffer_sizes.clear();
1340 Stopped(); /* EMIT SIGNAL */
1341 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1348 AudioEngine::reconnect_to_jack ()
1351 disconnect_from_jack ();
1352 /* XXX give jackd a chance */
1353 Glib::usleep (250000);
1356 if (connect_to_jack (jack_client_name, "")) {
1357 error << _("failed to connect to JACK") << endmsg;
1363 boost::shared_ptr<Ports> p = ports.reader ();
1365 for (i = p->begin(); i != p->end(); ++i) {
1366 if ((*i)->reestablish ()) {
1371 if (i != p->end()) {
1373 remove_all_ports ();
1377 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1379 MIDI::Manager::instance()->reestablish (_priv_jack);
1382 _session->reset_jack_connection (_priv_jack);
1383 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1384 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1387 last_monitor_check = 0;
1389 jack_on_shutdown (_priv_jack, halted, this);
1390 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1391 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1392 // jack_set_process_callback (_priv_jack, _process_callback, this);
1393 jack_set_process_thread (_priv_jack, _process_thread, this);
1394 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1395 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1396 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1397 #ifdef HAVE_JACK_SESSION
1398 if( jack_set_session_callback )
1399 jack_set_session_callback (_priv_jack, _session_callback, this);
1401 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1402 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1404 if (_session && _session->config.get_jack_time_master()) {
1405 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1408 if (jack_activate (_priv_jack) == 0) {
1415 /* re-establish connections */
1417 for (i = p->begin(); i != p->end(); ++i) {
1421 MIDI::Manager::instance()->reconnect ();
1423 Running (); /* EMIT SIGNAL*/
1425 start_metering_thread ();
1431 AudioEngine::request_buffer_size (pframes_t nframes)
1433 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1435 if (nframes == jack_get_buffer_size (_priv_jack)) {
1439 return jack_set_buffer_size (_priv_jack, nframes);
1443 AudioEngine::update_total_latencies ()
1445 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1446 GET_PRIVATE_JACK_POINTER (_jack);
1447 jack_recompute_total_latencies (_priv_jack);
1452 AudioEngine::make_port_name_relative (string portname)
1454 string::size_type len;
1455 string::size_type n;
1457 len = portname.length();
1459 for (n = 0; n < len; ++n) {
1460 if (portname[n] == ':') {
1465 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1466 return portname.substr (n+1);
1473 AudioEngine::make_port_name_non_relative (string portname)
1477 if (portname.find_first_of (':') != string::npos) {
1481 str = jack_client_name;
1489 AudioEngine::is_realtime () const
1491 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1492 return jack_is_realtime (_priv_jack);
1496 AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
1498 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1499 ThreadData* td = new ThreadData (this, f, stacksize);
1501 if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack),
1502 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1510 AudioEngine::_start_process_thread (void* arg)
1512 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1513 boost::function<void()> f = td->f;