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 = max_frames;
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 nframes_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 cerr << "MIDI port buffers = " << _raw_buffer_sizes[DataType::MIDI] << endl;
247 jack_port_unregister (_priv_jack, midi_port);
251 return _running ? 0 : -1;
255 AudioEngine::stop (bool forever)
257 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
261 disconnect_from_jack ();
263 jack_deactivate (_priv_jack);
264 Stopped(); /* EMIT SIGNAL */
265 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
269 return _running ? -1 : 0;
274 AudioEngine::get_sync_offset (nframes_t& offset) const
277 #ifdef HAVE_JACK_VIDEO_SUPPORT
279 GET_PRIVATE_JACK_POINTER_RET (_jack, false);
284 (void) jack_transport_query (_priv_jack, &pos);
286 if (pos.valid & JackVideoFrameOffset) {
287 offset = pos.video_offset;
300 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
301 jack_position_t* pos, int new_position, void *arg)
303 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
307 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
308 jack_position_t* pos, int new_position)
310 if (_jack && _session && _session->synced_to_jack()) {
311 _session->jack_timebase_callback (state, nframes, pos, new_position);
316 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
318 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
322 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
324 if (_jack && _session) {
325 return _session->jack_sync_callback (state, pos);
332 AudioEngine::_xrun_callback (void *arg)
334 AudioEngine* ae = static_cast<AudioEngine*> (arg);
335 if (ae->connected()) {
336 ae->Xrun (); /* EMIT SIGNAL */
341 #ifdef HAVE_JACK_SESSION
343 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
345 printf( "helo.... " );
346 AudioEngine* ae = static_cast<AudioEngine*> (arg);
347 if (ae->connected()) {
348 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
353 AudioEngine::_graph_order_callback (void *arg)
355 AudioEngine* ae = static_cast<AudioEngine*> (arg);
356 if (ae->connected()) {
357 ae->GraphReordered (); /* EMIT SIGNAL */
362 /** Wrapped which is called by JACK as its process callback. It is just
363 * here to get us back into C++ land by calling AudioEngine::process_callback()
364 * @param nframes Number of frames passed by JACK.
365 * @param arg User argument passed by JACK, which will be the AudioEngine*.
368 AudioEngine::_process_callback (nframes_t nframes, void *arg)
370 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
374 AudioEngine::_process_thread (void *arg)
376 return static_cast<AudioEngine *> (arg)->process_thread ();
380 AudioEngine::_freewheel_callback (int onoff, void *arg)
382 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
386 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
388 AudioEngine* ae = static_cast<AudioEngine*> (arg);
389 ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
393 AudioEngine::_connect_callback (jack_port_id_t /*id_a*/, jack_port_id_t /*id_b*/, int /*conn*/, void* arg)
395 AudioEngine* ae = static_cast<AudioEngine*> (arg);
396 ae->PortConnectedOrDisconnected (); /* EMIT SIGNAL */
400 AudioEngine::split_cycle (nframes_t offset)
402 /* caller must hold process lock */
404 Port::increment_port_offset (offset);
406 /* tell all Ports that we're going to start a new (split) cycle */
408 boost::shared_ptr<Ports> p = ports.reader();
410 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
411 (*i)->cycle_split ();
416 AudioEngine::finish_process_cycle (int status)
418 GET_PRIVATE_JACK_POINTER(_jack);
419 jack_cycle_signal (_jack, 0);
423 AudioEngine::process_thread ()
425 /* JACK doesn't do this for us when we use the wait API
428 _thread_init_callback (0);
430 _main_thread = new ProcessThread;
433 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
434 jack_nframes_t nframes = jack_cycle_wait (_jack);
436 if (process_callback (nframes)) {
437 cerr << "--- process\n";
441 finish_process_cycle (0);
447 /** Method called by JACK (via _process_callback) which says that there
448 * is work to be done.
449 * @param nframes Number of frames to process.
452 AudioEngine::process_callback (nframes_t nframes)
454 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
455 // CycleTimer ct ("AudioEngine::process");
456 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
458 /// The number of frames that will have been processed when we've finished
459 nframes_t next_processed_frames;
461 /* handle wrap around of total frames counter */
463 if (max_frames - _processed_frames < nframes) {
464 next_processed_frames = nframes - (max_frames - _processed_frames);
466 next_processed_frames = _processed_frames + nframes;
469 if (!tm.locked() || _session == 0) {
470 /* return having done nothing */
471 _processed_frames = next_processed_frames;
475 if (session_remove_pending) {
476 /* perform the actual session removal */
478 session_remove_pending = false;
479 session_removed.signal();
480 _processed_frames = next_processed_frames;
484 /* tell all relevant objects that we're starting a new cycle */
486 Delivery::CycleStart (nframes);
487 Port::set_port_offset (0);
488 InternalReturn::CycleStart (nframes);
490 /* tell all Ports that we're starting a new cycle */
492 boost::shared_ptr<Ports> p = ports.reader();
494 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
495 (*i)->cycle_start (nframes);
498 /* test if we are freewheeling and there are freewheel signals connected.
499 ardour should act normally even when freewheeling unless /it/ is exporting */
502 if (_freewheeling && !Freewheel.empty()) {
503 /* emit the Freewheel signal and stop freewheeling in the event of trouble
505 boost::optional<int> r = Freewheel (nframes);
506 if (r.get_value_or (0)) {
507 jack_set_freewheel (_priv_jack, false);
512 _session->process (nframes);
522 _processed_frames = next_processed_frames;
526 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
528 boost::shared_ptr<Ports> p = ports.reader();
530 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
535 if (port->_last_monitor != (x = port->monitoring_input ())) {
536 port->_last_monitor = x;
537 /* XXX I think this is dangerous, due to
538 a likely mutex in the signal handlers ...
540 port->MonitorInputChanged (x); /* EMIT SIGNAL */
543 last_monitor_check = next_processed_frames;
546 if (_session->silent()) {
548 boost::shared_ptr<Ports> p = ports.reader();
550 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
554 if (port->sends_output()) {
555 port->get_buffer(nframes).silence(nframes);
562 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
563 (*i)->cycle_end (nframes);
566 _processed_frames = next_processed_frames;
571 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
573 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
577 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
579 _frame_rate = nframes;
580 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
582 /* check for monitor input change every 1/10th of second */
584 monitor_check_interval = nframes / 10;
585 last_monitor_check = 0;
588 _session->set_frame_rate (nframes);
591 SampleRateChanged (nframes); /* EMIT SIGNAL */
597 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
599 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
603 AudioEngine::jack_bufsize_callback (nframes_t nframes)
605 bool need_midi_size = true;
606 bool need_audio_size = true;
608 _buffer_size = nframes;
609 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
610 last_monitor_check = 0;
612 boost::shared_ptr<Ports> p = ports.reader();
614 /* crude guesses, see below where we try to get the right answers.
616 Note that our guess for MIDI deliberatey tries to overestimate
617 by a little. It would be nicer if we could get the actual
618 size from a port, but we have to use this estimate in the
619 event that there are no MIDI ports currently. If there are
620 the value will be adjusted below.
623 _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
624 _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
626 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
628 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
629 _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
630 need_audio_size = false;
634 if (need_midi_size && (*i)->type() == DataType::MIDI) {
635 _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
636 need_midi_size = false;
643 _session->set_block_size (_buffer_size);
650 AudioEngine::stop_metering_thread ()
652 if (m_meter_thread) {
653 g_atomic_int_set (&m_meter_exit, 1);
654 m_meter_thread->join ();
660 AudioEngine::start_metering_thread ()
662 if (m_meter_thread == 0) {
663 g_atomic_int_set (&m_meter_exit, 0);
664 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
665 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
670 AudioEngine::meter_thread ()
672 pthread_set_name (X_("meter"));
675 Glib::usleep (10000); /* 1/100th sec interval */
676 if (g_atomic_int_get(&m_meter_exit)) {
684 AudioEngine::set_session (Session *s)
686 Glib::Mutex::Lock pl (_process_lock);
688 SessionHandlePtr::set_session (s);
692 start_metering_thread ();
694 nframes_t blocksize = jack_get_buffer_size (_jack);
696 /* page in as much of the session process code as we
697 can before we really start running.
700 boost::shared_ptr<Ports> p = ports.reader();
702 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
703 (*i)->cycle_start (blocksize);
706 _session->process (blocksize);
707 _session->process (blocksize);
708 _session->process (blocksize);
709 _session->process (blocksize);
710 _session->process (blocksize);
711 _session->process (blocksize);
712 _session->process (blocksize);
713 _session->process (blocksize);
715 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
716 (*i)->cycle_end (blocksize);
722 AudioEngine::remove_session ()
724 Glib::Mutex::Lock lm (_process_lock);
728 stop_metering_thread ();
731 session_remove_pending = true;
732 session_removed.wait(_process_lock);
736 SessionHandlePtr::set_session (0);
743 AudioEngine::port_registration_failure (const std::string& portname)
745 GET_PRIVATE_JACK_POINTER (_jack);
746 string full_portname = jack_client_name;
747 full_portname += ':';
748 full_portname += portname;
751 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
755 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
757 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);
760 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
764 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
769 if (dtype == DataType::AUDIO) {
770 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
771 } else if (dtype == DataType::MIDI) {
772 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
774 throw PortRegistrationFailure("unable to create port (unknown type)");
777 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
778 size_t port_buffer_size = newport->raw_buffer_size(0);
779 if (port_buffer_size > old_buffer_size) {
780 old_buffer_size = port_buffer_size;
783 RCUWriter<Ports> writer (ports);
784 boost::shared_ptr<Ports> ps = writer.get_copy ();
785 ps->insert (ps->begin(), newport);
787 /* writer goes out of scope, forces update */
792 catch (PortRegistrationFailure& err) {
794 } catch (std::exception& e) {
795 throw PortRegistrationFailure(string_compose(
796 _("unable to create port: %1"), e.what()).c_str());
798 throw PortRegistrationFailure("unable to create port (unknown error)");
803 AudioEngine::register_input_port (DataType type, const string& portname)
805 return register_port (type, portname, true);
809 AudioEngine::register_output_port (DataType type, const string& portname)
811 return register_port (type, portname, false);
815 AudioEngine::unregister_port (Port& port)
817 /* caller must hold process lock */
820 /* probably happening when the engine has been halted by JACK,
821 in which case, there is nothing we can do here.
827 RCUWriter<Ports> writer (ports);
828 boost::shared_ptr<Ports> ps = writer.get_copy ();
830 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
838 /* writer goes out of scope, forces update */
845 AudioEngine::connect (const string& source, const string& destination)
847 /* caller must hold process lock */
853 fatal << _("connect called before engine was started") << endmsg;
860 string s = make_port_name_non_relative (source);
861 string d = make_port_name_non_relative (destination);
864 Port* src = get_port_by_name_locked (s);
865 Port* dst = get_port_by_name_locked (d);
868 ret = src->connect (d);
870 ret = dst->connect (s);
872 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
877 /* already exists - no error, no warning */
878 } else if (ret < 0) {
879 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
880 source, s, destination, d)
888 AudioEngine::disconnect (const string& source, const string& destination)
890 /* caller must hold process lock */
896 fatal << _("disconnect called before engine was started") << endmsg;
903 string s = make_port_name_non_relative (source);
904 string d = make_port_name_non_relative (destination);
906 Port* src = get_port_by_name_locked (s);
907 Port* dst = get_port_by_name_locked (d);
910 ret = src->disconnect (d);
912 ret = dst->disconnect (s);
914 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
921 AudioEngine::disconnect (Port& port)
923 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
927 fatal << _("disconnect called before engine was started") << endmsg;
934 return port.disconnect_all ();
938 AudioEngine::frame_rate () const
940 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
941 if (_frame_rate == 0) {
942 return (_frame_rate = jack_get_sample_rate (_priv_jack));
949 AudioEngine::raw_buffer_size (DataType t)
951 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
952 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
956 AudioEngine::frames_per_cycle () const
958 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
959 if (_buffer_size == 0) {
960 return (_buffer_size = jack_get_buffer_size (_jack));
966 /** @param name Full name of port (including prefix:)
967 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
968 * so must not be deleted.
971 AudioEngine::get_port_by_name (const string& portname)
974 if (portname.find_first_of (':') == string::npos) {
975 s = make_port_name_non_relative (portname);
980 Glib::Mutex::Lock lm (_process_lock);
981 return get_port_by_name_locked (s);
985 AudioEngine::get_port_by_name_locked (const string& portname)
987 /* caller must hold process lock */
991 fatal << _("get_port_by_name_locked() called before engine was started") << endmsg;
998 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
999 /* not an ardour: port */
1003 std::string const rel = make_port_name_relative (portname);
1005 boost::shared_ptr<Ports> pr = ports.reader();
1007 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1008 if (rel == (*i)->name()) {
1017 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1019 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1022 fatal << _("get_ports called before engine was started") << endmsg;
1028 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1032 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1034 /* called from jack shutdown handler */
1036 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1037 bool was_running = ae->_running;
1039 ae->stop_metering_thread ();
1041 ae->_running = false;
1042 ae->_buffer_size = 0;
1043 ae->_frame_rate = 0;
1047 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1049 case JackBackendError:
1050 ae->Halted(reason); /* EMIT SIGNAL */
1053 ae->Halted(""); /* EMIT SIGNAL */
1056 ae->Halted(""); /* EMIT SIGNAL */
1062 AudioEngine::halted (void *arg)
1064 cerr << "HALTED by JACK\n";
1066 /* called from jack shutdown handler */
1068 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1069 bool was_running = ae->_running;
1071 ae->stop_metering_thread ();
1073 ae->_running = false;
1074 ae->_buffer_size = 0;
1075 ae->_frame_rate = 0;
1079 ae->Halted(""); /* EMIT SIGNAL */
1080 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1085 AudioEngine::died ()
1087 /* called from a signal handler for SIGPIPE */
1089 stop_metering_thread ();
1098 AudioEngine::can_request_hardware_monitoring ()
1100 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1101 const char ** ports;
1103 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1113 AudioEngine::n_physical (unsigned long flags) const
1117 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1119 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1124 for (uint32_t i = 0; ports[i]; ++i) {
1125 if (!strstr (ports[i], "Midi-Through")) {
1126 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1127 c.set (t, c.get (t) + 1);
1137 AudioEngine::n_physical_inputs () const
1139 return n_physical (JackPortIsInput);
1143 AudioEngine::n_physical_outputs () const
1145 return n_physical (JackPortIsOutput);
1149 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1151 GET_PRIVATE_JACK_POINTER (_jack);
1152 const char ** ports;
1154 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1159 for (uint32_t i = 0; ports[i]; ++i) {
1160 if (strstr (ports[i], "Midi-Through")) {
1163 phy.push_back (ports[i]);
1170 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1172 get_physical (type, JackPortIsInput, ins);
1176 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1178 get_physical (type, JackPortIsOutput, outs);
1182 AudioEngine::update_total_latency (const Port& port)
1184 port.recompute_total_latency ();
1188 AudioEngine::transport_stop ()
1190 GET_PRIVATE_JACK_POINTER (_jack);
1191 jack_transport_stop (_priv_jack);
1195 AudioEngine::transport_start ()
1197 GET_PRIVATE_JACK_POINTER (_jack);
1198 jack_transport_start (_priv_jack);
1202 AudioEngine::transport_locate (nframes_t where)
1204 GET_PRIVATE_JACK_POINTER (_jack);
1205 // cerr << "tell JACK to locate to " << where << endl;
1206 jack_transport_locate (_priv_jack, where);
1209 AudioEngine::TransportState
1210 AudioEngine::transport_state ()
1212 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1213 jack_position_t pos;
1214 return (TransportState) jack_transport_query (_priv_jack, &pos);
1218 AudioEngine::reset_timebase ()
1220 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1222 if (_session->config.get_jack_time_master()) {
1223 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1225 return jack_release_timebase (_jack);
1232 AudioEngine::freewheel (bool onoff)
1234 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1236 if (onoff != _freewheeling) {
1237 return jack_set_freewheel (_priv_jack, onoff);
1240 /* already doing what has been asked for */
1246 AudioEngine::remove_all_ports ()
1248 /* process lock MUST be held */
1251 RCUWriter<Ports> writer (ports);
1252 boost::shared_ptr<Ports> ps = writer.get_copy ();
1254 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1261 /* clear dead wood list too */
1267 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1269 jack_options_t options = JackNullOption;
1270 jack_status_t status;
1271 const char *server_name = NULL;
1273 jack_client_name = client_name; /* might be reset below */
1274 #ifdef HAVE_JACK_SESSION
1275 if (! session_uuid.empty())
1276 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1279 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1281 if (_jack == NULL) {
1282 // error message is not useful here
1286 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1288 if (status & JackNameNotUnique) {
1289 jack_client_name = jack_get_client_name (_priv_jack);
1296 AudioEngine::disconnect_from_jack ()
1298 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1301 stop_metering_thread ();
1305 Glib::Mutex::Lock lm (_process_lock);
1306 jack_client_close (_priv_jack);
1312 _raw_buffer_sizes.clear();
1316 Stopped(); /* EMIT SIGNAL */
1317 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1324 AudioEngine::reconnect_to_jack ()
1327 disconnect_from_jack ();
1328 /* XXX give jackd a chance */
1329 Glib::usleep (250000);
1332 if (connect_to_jack (jack_client_name, "")) {
1333 error << _("failed to connect to JACK") << endmsg;
1339 boost::shared_ptr<Ports> p = ports.reader ();
1341 for (i = p->begin(); i != p->end(); ++i) {
1342 if ((*i)->reestablish ()) {
1347 if (i != p->end()) {
1349 remove_all_ports ();
1353 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1355 MIDI::Manager::instance()->reestablish (_priv_jack);
1358 _session->reset_jack_connection (_priv_jack);
1359 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1360 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1363 last_monitor_check = 0;
1365 jack_on_shutdown (_priv_jack, halted, this);
1366 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1367 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1368 // jack_set_process_callback (_priv_jack, _process_callback, this);
1369 jack_set_process_thread (_priv_jack, _process_thread, this);
1370 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1371 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1372 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1373 #ifdef HAVE_JACK_SESSION
1374 if( jack_set_session_callback )
1375 jack_set_session_callback (_priv_jack, _session_callback, this);
1377 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1378 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1380 if (_session && _session->config.get_jack_time_master()) {
1381 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1384 if (jack_activate (_priv_jack) == 0) {
1391 /* re-establish connections */
1393 for (i = p->begin(); i != p->end(); ++i) {
1397 MIDI::Manager::instance()->reconnect ();
1399 Running (); /* EMIT SIGNAL*/
1401 start_metering_thread ();
1407 AudioEngine::request_buffer_size (nframes_t nframes)
1409 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1411 if (nframes == jack_get_buffer_size (_priv_jack)) {
1415 return jack_set_buffer_size (_priv_jack, nframes);
1419 AudioEngine::update_total_latencies ()
1421 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1422 GET_PRIVATE_JACK_POINTER (_jack);
1423 jack_recompute_total_latencies (_priv_jack);
1428 AudioEngine::make_port_name_relative (string portname)
1430 string::size_type len;
1431 string::size_type n;
1433 len = portname.length();
1435 for (n = 0; n < len; ++n) {
1436 if (portname[n] == ':') {
1441 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1442 return portname.substr (n+1);
1449 AudioEngine::make_port_name_non_relative (string portname)
1453 if (portname.find_first_of (':') != string::npos) {
1457 str = jack_client_name;
1465 AudioEngine::is_realtime () const
1467 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1468 return jack_is_realtime (_priv_jack);
1472 AudioEngine::create_process_thread (boost::function<void()> f, size_t stacksize)
1474 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1476 ThreadData* td = new ThreadData (this, f, stacksize);
1478 if (jack_client_create_thread (_priv_jack, &thread, jack_client_real_time_priority (_priv_jack),
1479 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1487 AudioEngine::_start_process_thread (void* arg)
1489 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1490 boost::function<void()> f = td->f;