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"
35 #include "midi++/port.h"
36 #include "midi++/mmc.h"
37 #include "midi++/manager.h"
39 #include "ardour/amp.h"
40 #include "ardour/audio_port.h"
41 #include "ardour/audioengine.h"
42 #include "ardour/buffer.h"
43 #include "ardour/buffer_set.h"
44 #include "ardour/cycle_timer.h"
45 #include "ardour/delivery.h"
46 #include "ardour/event_type_map.h"
47 #include "ardour/internal_return.h"
48 #include "ardour/io.h"
49 #include "ardour/meter.h"
50 #include "ardour/midi_port.h"
51 #include "ardour/process_thread.h"
52 #include "ardour/port.h"
53 #include "ardour/port_set.h"
54 #include "ardour/session.h"
55 #include "ardour/timestamps.h"
56 #include "ardour/utils.h"
61 using namespace ARDOUR;
64 gint AudioEngine::m_meter_exit;
65 AudioEngine* AudioEngine::_instance = 0;
67 #define GET_PRIVATE_JACK_POINTER(j) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; }
68 #define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; }
70 AudioEngine::AudioEngine (string client_name, string session_uuid)
73 _instance = this; /* singleton */
75 session_remove_pending = false;
78 last_monitor_check = 0;
79 monitor_check_interval = INT32_MAX;
80 _processed_frames = 0;
85 _freewheeling = false;
89 g_atomic_int_set (&m_meter_exit, 0);
91 if (connect_to_jack (client_name, session_uuid)) {
92 throw NoBackendAvailable ();
95 Port::set_engine (this);
97 // Initialize parameter metadata (e.g. ranges)
98 Evoral::Parameter p(NullAutomation);
99 p = EventTypeMap::instance().new_parameter(NullAutomation);
100 p = EventTypeMap::instance().new_parameter(GainAutomation);
101 p = EventTypeMap::instance().new_parameter(PanAutomation);
102 p = EventTypeMap::instance().new_parameter(PluginAutomation);
103 p = EventTypeMap::instance().new_parameter(SoloAutomation);
104 p = EventTypeMap::instance().new_parameter(MuteAutomation);
105 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
106 p = EventTypeMap::instance().new_parameter(MidiPgmChangeAutomation);
107 p = EventTypeMap::instance().new_parameter(MidiPitchBenderAutomation);
108 p = EventTypeMap::instance().new_parameter(MidiChannelPressureAutomation);
109 p = EventTypeMap::instance().new_parameter(FadeInAutomation);
110 p = EventTypeMap::instance().new_parameter(FadeOutAutomation);
111 p = EventTypeMap::instance().new_parameter(EnvelopeAutomation);
112 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
115 AudioEngine::~AudioEngine ()
118 Glib::Mutex::Lock tm (_process_lock);
119 session_removed.signal ();
122 jack_client_close (_jack);
126 stop_metering_thread ();
131 AudioEngine::jack() const
137 _thread_init_callback (void * /*arg*/)
139 /* make sure that anybody who needs to know about this thread
143 pthread_set_name (X_("audioengine"));
145 PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
146 PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
148 SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
150 MIDI::Port::set_process_thread (pthread_self());
153 typedef void (*_JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);
155 static void (*on_info_shutdown)(jack_client_t*, _JackInfoShutdownCallback, void *);
156 extern void jack_on_info_shutdown (jack_client_t*, _JackInfoShutdownCallback, void *) __attribute__((weak));
158 static void check_jack_symbols () __attribute__((constructor));
160 void check_jack_symbols ()
162 /* use weak linking to see if we really have various late-model JACK function */
163 on_info_shutdown = jack_on_info_shutdown;
167 ardour_jack_error (const char* msg)
169 error << "JACK: " << msg << endmsg;
173 AudioEngine::start ()
175 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
179 pframes_t blocksize = jack_get_buffer_size (_priv_jack);
182 BootMessage (_("Connect session to engine"));
184 _session->set_block_size (blocksize);
185 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
187 /* page in as much of the session process code as we
188 can before we really start running.
191 _session->process (blocksize);
192 _session->process (blocksize);
193 _session->process (blocksize);
194 _session->process (blocksize);
195 _session->process (blocksize);
196 _session->process (blocksize);
197 _session->process (blocksize);
198 _session->process (blocksize);
201 _processed_frames = 0;
202 last_monitor_check = 0;
204 if (on_info_shutdown) {
205 jack_on_info_shutdown (_priv_jack, halted_info, this);
207 jack_on_shutdown (_priv_jack, halted, this);
209 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
210 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
211 // jack_set_process_callback (_priv_jack, _process_callback, this);
212 jack_set_process_thread (_priv_jack, _process_thread, this);
213 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
214 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
215 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
216 #ifdef HAVE_JACK_SESSION
217 if( jack_set_session_callback )
218 jack_set_session_callback (_priv_jack, _session_callback, this);
220 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
221 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
222 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
223 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
225 if (_session && _session->config.get_jack_time_master()) {
226 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
229 jack_set_error_function (ardour_jack_error);
231 if (jack_activate (_priv_jack) == 0) {
234 Running(); /* EMIT SIGNAL */
236 // error << _("cannot activate JACK client") << endmsg;
239 _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
241 jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
243 error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
245 _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
246 jack_port_unregister (_priv_jack, midi_port);
250 return _running ? 0 : -1;
254 AudioEngine::stop (bool forever)
256 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
260 disconnect_from_jack ();
262 jack_deactivate (_priv_jack);
263 Stopped(); /* EMIT SIGNAL */
264 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
269 stop_metering_thread ();
272 return _running ? -1 : 0;
277 AudioEngine::get_sync_offset (pframes_t& offset) const
280 #ifdef HAVE_JACK_VIDEO_SUPPORT
282 GET_PRIVATE_JACK_POINTER_RET (_jack, false);
287 (void) jack_transport_query (_priv_jack, &pos);
289 if (pos.valid & JackVideoFrameOffset) {
290 offset = pos.video_offset;
303 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
304 jack_position_t* pos, int new_position, void *arg)
306 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
310 AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
311 jack_position_t* pos, int new_position)
313 if (_jack && _session && _session->synced_to_jack()) {
314 _session->jack_timebase_callback (state, nframes, pos, new_position);
319 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
321 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
325 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
327 if (_jack && _session) {
328 return _session->jack_sync_callback (state, pos);
335 AudioEngine::_xrun_callback (void *arg)
337 AudioEngine* ae = static_cast<AudioEngine*> (arg);
338 if (ae->connected()) {
339 ae->Xrun (); /* EMIT SIGNAL */
344 #ifdef HAVE_JACK_SESSION
346 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
348 printf( "helo.... " );
349 AudioEngine* ae = static_cast<AudioEngine*> (arg);
350 if (ae->connected()) {
351 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
356 AudioEngine::_graph_order_callback (void *arg)
358 AudioEngine* ae = static_cast<AudioEngine*> (arg);
359 if (ae->connected()) {
360 ae->GraphReordered (); /* EMIT SIGNAL */
365 /** Wrapped which is called by JACK as its process callback. It is just
366 * here to get us back into C++ land by calling AudioEngine::process_callback()
367 * @param nframes Number of frames passed by JACK.
368 * @param arg User argument passed by JACK, which will be the AudioEngine*.
371 AudioEngine::_process_callback (pframes_t nframes, void *arg)
373 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
377 AudioEngine::_process_thread (void *arg)
379 return static_cast<AudioEngine *> (arg)->process_thread ();
383 AudioEngine::_freewheel_callback (int onoff, void *arg)
385 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
389 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
391 AudioEngine* ae = static_cast<AudioEngine*> (arg);
392 ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
396 AudioEngine::_connect_callback (jack_port_id_t /*id_a*/, jack_port_id_t /*id_b*/, int /*conn*/, void* arg)
398 AudioEngine* ae = static_cast<AudioEngine*> (arg);
399 ae->PortConnectedOrDisconnected (); /* EMIT SIGNAL */
403 AudioEngine::split_cycle (pframes_t offset)
405 /* caller must hold process lock */
407 AudioPort::increment_port_offset (offset);
409 /* tell all Ports that we're going to start a new (split) cycle */
411 boost::shared_ptr<Ports> p = ports.reader();
413 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
414 (*i)->cycle_split ();
419 AudioEngine::finish_process_cycle (int /* status*/ )
421 GET_PRIVATE_JACK_POINTER(_jack);
422 jack_cycle_signal (_jack, 0);
426 AudioEngine::process_thread ()
428 /* JACK doesn't do this for us when we use the wait API
431 _thread_init_callback (0);
433 _main_thread = new ProcessThread;
436 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
437 pframes_t nframes = jack_cycle_wait (_jack);
439 if (process_callback (nframes)) {
440 cerr << "--- process\n";
444 finish_process_cycle (0);
450 /** Method called by JACK (via _process_callback) which says that there
451 * is work to be done.
452 * @param nframes Number of frames to process.
455 AudioEngine::process_callback (pframes_t nframes)
457 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
458 // CycleTimer ct ("AudioEngine::process");
459 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
461 /// The number of frames that will have been processed when we've finished
462 pframes_t next_processed_frames;
464 /* handle wrap around of total frames counter */
466 if (max_framepos - _processed_frames < nframes) {
467 next_processed_frames = nframes - (max_framepos - _processed_frames);
469 next_processed_frames = _processed_frames + nframes;
472 if (!tm.locked() || _session == 0) {
473 /* return having done nothing */
474 _processed_frames = next_processed_frames;
478 if (session_remove_pending) {
479 /* perform the actual session removal */
481 session_remove_pending = false;
482 session_removed.signal();
483 _processed_frames = next_processed_frames;
487 /* tell all relevant objects that we're starting a new cycle */
489 Delivery::CycleStart (nframes);
490 AudioPort::set_port_offset (0);
491 InternalReturn::CycleStart (nframes);
493 /* tell all Ports that we're starting a new cycle */
495 boost::shared_ptr<Ports> p = ports.reader();
497 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
498 (*i)->cycle_start (nframes);
501 /* test if we are freewheeling and there are freewheel signals connected.
502 ardour should act normally even when freewheeling unless /it/ is exporting */
505 if (_freewheeling && !Freewheel.empty()) {
506 /* emit the Freewheel signal and stop freewheeling in the event of trouble
508 boost::optional<int> r = Freewheel (nframes);
509 if (r.get_value_or (0)) {
510 jack_set_freewheel (_priv_jack, false);
515 _session->process (nframes);
525 _processed_frames = next_processed_frames;
529 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
531 boost::shared_ptr<Ports> p = ports.reader();
533 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
538 if (port->_last_monitor != (x = port->monitoring_input ())) {
539 port->_last_monitor = x;
540 /* XXX I think this is dangerous, due to
541 a likely mutex in the signal handlers ...
543 port->MonitorInputChanged (x); /* EMIT SIGNAL */
546 last_monitor_check = next_processed_frames;
549 if (_session->silent()) {
551 boost::shared_ptr<Ports> p = ports.reader();
553 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
557 if (port->sends_output()) {
558 port->get_buffer(nframes).silence(nframes);
565 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
566 (*i)->cycle_end (nframes);
569 _processed_frames = next_processed_frames;
574 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
576 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
580 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
582 _frame_rate = nframes;
583 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
585 /* check for monitor input change every 1/10th of second */
587 monitor_check_interval = nframes / 10;
588 last_monitor_check = 0;
591 _session->set_frame_rate (nframes);
594 SampleRateChanged (nframes); /* EMIT SIGNAL */
600 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
602 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
606 AudioEngine::jack_bufsize_callback (pframes_t nframes)
608 bool need_midi_size = true;
609 bool need_audio_size = true;
611 _buffer_size = nframes;
612 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
613 last_monitor_check = 0;
615 boost::shared_ptr<Ports> p = ports.reader();
617 /* crude guesses, see below where we try to get the right answers.
619 Note that our guess for MIDI deliberatey tries to overestimate
620 by a little. It would be nicer if we could get the actual
621 size from a port, but we have to use this estimate in the
622 event that there are no MIDI ports currently. If there are
623 the value will be adjusted below.
626 _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
627 _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
629 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
631 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
632 _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
633 need_audio_size = false;
637 if (need_midi_size && (*i)->type() == DataType::MIDI) {
638 _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
639 need_midi_size = false;
646 _session->set_block_size (_buffer_size);
653 AudioEngine::stop_metering_thread ()
655 if (m_meter_thread) {
656 g_atomic_int_set (&m_meter_exit, 1);
657 m_meter_thread->join ();
663 AudioEngine::start_metering_thread ()
665 if (m_meter_thread == 0) {
666 g_atomic_int_set (&m_meter_exit, 0);
667 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
668 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
673 AudioEngine::meter_thread ()
675 pthread_set_name (X_("meter"));
678 Glib::usleep (10000); /* 1/100th sec interval */
679 if (g_atomic_int_get(&m_meter_exit)) {
687 AudioEngine::set_session (Session *s)
689 Glib::Mutex::Lock pl (_process_lock);
691 SessionHandlePtr::set_session (s);
695 start_metering_thread ();
697 pframes_t blocksize = jack_get_buffer_size (_jack);
699 /* page in as much of the session process code as we
700 can before we really start running.
703 boost::shared_ptr<Ports> p = ports.reader();
705 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
706 (*i)->cycle_start (blocksize);
709 _session->process (blocksize);
710 _session->process (blocksize);
711 _session->process (blocksize);
712 _session->process (blocksize);
713 _session->process (blocksize);
714 _session->process (blocksize);
715 _session->process (blocksize);
716 _session->process (blocksize);
718 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
719 (*i)->cycle_end (blocksize);
725 AudioEngine::remove_session ()
727 Glib::Mutex::Lock lm (_process_lock);
731 stop_metering_thread ();
734 session_remove_pending = true;
735 session_removed.wait(_process_lock);
739 SessionHandlePtr::set_session (0);
746 AudioEngine::port_registration_failure (const std::string& portname)
748 GET_PRIVATE_JACK_POINTER (_jack);
749 string full_portname = jack_client_name;
750 full_portname += ':';
751 full_portname += portname;
754 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
758 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
760 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);
763 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
767 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
772 if (dtype == DataType::AUDIO) {
773 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
774 } else if (dtype == DataType::MIDI) {
775 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
777 throw PortRegistrationFailure("unable to create port (unknown type)");
780 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
781 size_t port_buffer_size = newport->raw_buffer_size(0);
782 if (port_buffer_size > old_buffer_size) {
783 old_buffer_size = port_buffer_size;
786 RCUWriter<Ports> writer (ports);
787 boost::shared_ptr<Ports> ps = writer.get_copy ();
788 ps->insert (ps->begin(), newport);
790 /* writer goes out of scope, forces update */
795 catch (PortRegistrationFailure& err) {
797 } catch (std::exception& e) {
798 throw PortRegistrationFailure(string_compose(
799 _("unable to create port: %1"), e.what()).c_str());
801 throw PortRegistrationFailure("unable to create port (unknown error)");
806 AudioEngine::register_input_port (DataType type, const string& portname)
808 return register_port (type, portname, true);
812 AudioEngine::register_output_port (DataType type, const string& portname)
814 return register_port (type, portname, false);
818 AudioEngine::unregister_port (Port& port)
820 /* caller must hold process lock */
823 /* probably happening when the engine has been halted by JACK,
824 in which case, there is nothing we can do here.
830 RCUWriter<Ports> writer (ports);
831 boost::shared_ptr<Ports> ps = writer.get_copy ();
833 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
841 /* writer goes out of scope, forces update */
848 AudioEngine::connect (const string& source, const string& destination)
854 fatal << _("connect called before engine was started") << endmsg;
861 string s = make_port_name_non_relative (source);
862 string d = make_port_name_non_relative (destination);
865 Port* src = get_port_by_name (s);
866 Port* dst = get_port_by_name (d);
869 ret = src->connect (d);
871 ret = dst->connect (s);
873 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
878 /* already exists - no error, no warning */
879 } else if (ret < 0) {
880 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
881 source, s, destination, d)
889 AudioEngine::disconnect (const string& source, const string& destination)
895 fatal << _("disconnect called before engine was started") << endmsg;
902 string s = make_port_name_non_relative (source);
903 string d = make_port_name_non_relative (destination);
905 Port* src = get_port_by_name (s);
906 Port* dst = get_port_by_name (d);
909 ret = src->disconnect (d);
911 ret = dst->disconnect (s);
913 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
920 AudioEngine::disconnect (Port& port)
922 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
926 fatal << _("disconnect called before engine was started") << endmsg;
933 return port.disconnect_all ();
937 AudioEngine::frame_rate () const
939 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
940 if (_frame_rate == 0) {
941 return (_frame_rate = jack_get_sample_rate (_priv_jack));
948 AudioEngine::raw_buffer_size (DataType t)
950 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
951 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
955 AudioEngine::frames_per_cycle () const
957 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
958 if (_buffer_size == 0) {
959 return (_buffer_size = jack_get_buffer_size (_jack));
965 /** @param name Full name of port (including prefix:)
966 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
967 * so must not be deleted.
970 AudioEngine::get_port_by_name (const string& portname)
976 fatal << _("get_port_by_name() called before engine was started") << endmsg;
983 if (portname.find_first_of (':') == string::npos) {
984 s = make_port_name_non_relative (portname);
989 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
990 /* not an ardour: port */
994 std::string const rel = make_port_name_relative (portname);
996 boost::shared_ptr<Ports> pr = ports.reader();
998 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
999 if (rel == (*i)->name()) {
1008 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1010 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1013 fatal << _("get_ports called before engine was started") << endmsg;
1019 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1023 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1025 /* called from jack shutdown handler */
1027 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1028 bool was_running = ae->_running;
1030 ae->stop_metering_thread ();
1032 ae->_running = false;
1033 ae->_buffer_size = 0;
1034 ae->_frame_rate = 0;
1038 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1040 case JackBackendError:
1041 ae->Halted(reason); /* EMIT SIGNAL */
1044 ae->Halted(""); /* EMIT SIGNAL */
1047 ae->Halted(""); /* EMIT SIGNAL */
1053 AudioEngine::halted (void *arg)
1055 cerr << "HALTED by JACK\n";
1057 /* called from jack shutdown handler */
1059 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1060 bool was_running = ae->_running;
1062 ae->stop_metering_thread ();
1064 ae->_running = false;
1065 ae->_buffer_size = 0;
1066 ae->_frame_rate = 0;
1070 ae->Halted(""); /* EMIT SIGNAL */
1071 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1076 AudioEngine::died ()
1078 /* called from a signal handler for SIGPIPE */
1080 stop_metering_thread ();
1089 AudioEngine::can_request_hardware_monitoring ()
1091 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1092 const char ** ports;
1094 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1104 AudioEngine::n_physical (unsigned long flags) const
1108 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1110 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1115 for (uint32_t i = 0; ports[i]; ++i) {
1116 if (!strstr (ports[i], "Midi-Through")) {
1117 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1118 c.set (t, c.get (t) + 1);
1128 AudioEngine::n_physical_inputs () const
1130 return n_physical (JackPortIsInput);
1134 AudioEngine::n_physical_outputs () const
1136 return n_physical (JackPortIsOutput);
1140 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1142 GET_PRIVATE_JACK_POINTER (_jack);
1143 const char ** ports;
1145 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1150 for (uint32_t i = 0; ports[i]; ++i) {
1151 if (strstr (ports[i], "Midi-Through")) {
1154 phy.push_back (ports[i]);
1160 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1161 * a physical input connector.
1164 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1166 get_physical (type, JackPortIsOutput, ins);
1169 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1170 * a physical output connector.
1173 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1175 get_physical (type, JackPortIsInput, outs);
1179 AudioEngine::update_total_latency (const Port& port)
1181 port.recompute_total_latency ();
1185 AudioEngine::transport_stop ()
1187 GET_PRIVATE_JACK_POINTER (_jack);
1188 jack_transport_stop (_priv_jack);
1192 AudioEngine::transport_start ()
1194 GET_PRIVATE_JACK_POINTER (_jack);
1195 jack_transport_start (_priv_jack);
1199 AudioEngine::transport_locate (framepos_t where)
1201 GET_PRIVATE_JACK_POINTER (_jack);
1202 // cerr << "tell JACK to locate to " << where << endl;
1203 jack_transport_locate (_priv_jack, where);
1206 AudioEngine::TransportState
1207 AudioEngine::transport_state ()
1209 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1210 jack_position_t pos;
1211 return (TransportState) jack_transport_query (_priv_jack, &pos);
1215 AudioEngine::reset_timebase ()
1217 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1219 if (_session->config.get_jack_time_master()) {
1220 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1222 return jack_release_timebase (_jack);
1229 AudioEngine::freewheel (bool onoff)
1231 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1233 if (onoff != _freewheeling) {
1234 return jack_set_freewheel (_priv_jack, onoff);
1237 /* already doing what has been asked for */
1243 AudioEngine::remove_all_ports ()
1245 /* process lock MUST be held */
1248 RCUWriter<Ports> writer (ports);
1249 boost::shared_ptr<Ports> ps = writer.get_copy ();
1251 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1258 /* clear dead wood list too */
1264 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1266 jack_options_t options = JackNullOption;
1267 jack_status_t status;
1268 const char *server_name = NULL;
1270 jack_client_name = client_name; /* might be reset below */
1271 #ifdef HAVE_JACK_SESSION
1272 if (! session_uuid.empty())
1273 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1276 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1278 if (_jack == NULL) {
1279 // error message is not useful here
1283 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1285 if (status & JackNameNotUnique) {
1286 jack_client_name = jack_get_client_name (_priv_jack);
1293 AudioEngine::disconnect_from_jack ()
1295 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1298 stop_metering_thread ();
1302 Glib::Mutex::Lock lm (_process_lock);
1303 jack_client_close (_priv_jack);
1309 _raw_buffer_sizes.clear();
1313 Stopped(); /* EMIT SIGNAL */
1314 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1321 AudioEngine::reconnect_to_jack ()
1324 disconnect_from_jack ();
1325 /* XXX give jackd a chance */
1326 Glib::usleep (250000);
1329 if (connect_to_jack (jack_client_name, "")) {
1330 error << _("failed to connect to JACK") << endmsg;
1336 boost::shared_ptr<Ports> p = ports.reader ();
1338 for (i = p->begin(); i != p->end(); ++i) {
1339 if ((*i)->reestablish ()) {
1344 if (i != p->end()) {
1346 remove_all_ports ();
1350 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1352 MIDI::Manager::instance()->reestablish (_priv_jack);
1355 _session->reset_jack_connection (_priv_jack);
1356 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1357 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1360 last_monitor_check = 0;
1362 jack_on_shutdown (_priv_jack, halted, this);
1363 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1364 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1365 // jack_set_process_callback (_priv_jack, _process_callback, this);
1366 jack_set_process_thread (_priv_jack, _process_thread, this);
1367 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1368 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1369 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1370 #ifdef HAVE_JACK_SESSION
1371 if( jack_set_session_callback )
1372 jack_set_session_callback (_priv_jack, _session_callback, this);
1374 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1375 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1377 if (_session && _session->config.get_jack_time_master()) {
1378 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1381 if (jack_activate (_priv_jack) == 0) {
1388 /* re-establish connections */
1390 for (i = p->begin(); i != p->end(); ++i) {
1394 MIDI::Manager::instance()->reconnect ();
1396 Running (); /* EMIT SIGNAL*/
1398 start_metering_thread ();
1404 AudioEngine::request_buffer_size (pframes_t nframes)
1406 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1408 if (nframes == jack_get_buffer_size (_priv_jack)) {
1412 return jack_set_buffer_size (_priv_jack, nframes);
1416 AudioEngine::update_total_latencies ()
1418 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1419 GET_PRIVATE_JACK_POINTER (_jack);
1420 jack_recompute_total_latencies (_priv_jack);
1425 AudioEngine::make_port_name_relative (string portname)
1427 string::size_type len;
1428 string::size_type n;
1430 len = portname.length();
1432 for (n = 0; n < len; ++n) {
1433 if (portname[n] == ':') {
1438 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1439 return portname.substr (n+1);
1446 AudioEngine::make_port_name_non_relative (string portname)
1450 if (portname.find_first_of (':') != string::npos) {
1454 str = jack_client_name;
1462 AudioEngine::is_realtime () const
1464 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1465 return jack_is_realtime (_priv_jack);
1469 AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
1471 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1472 ThreadData* td = new ThreadData (this, f, stacksize);
1474 if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack),
1475 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1483 AudioEngine::_start_process_thread (void* arg)
1485 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1486 boost::function<void()> f = td->f;