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/weakjack.h>
29 #include <jack/jack.h>
30 #include <jack/thread.h>
32 #include "pbd/pthread_utils.h"
33 #include "pbd/stacktrace.h"
34 #include "pbd/unknown_type.h"
37 #include "midi++/port.h"
38 #include "midi++/mmc.h"
39 #include "midi++/manager.h"
41 #include "ardour/amp.h"
42 #include "ardour/audio_port.h"
43 #include "ardour/audioengine.h"
44 #include "ardour/buffer.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/cycle_timer.h"
47 #include "ardour/delivery.h"
48 #include "ardour/event_type_map.h"
49 #include "ardour/internal_return.h"
50 #include "ardour/io.h"
51 #include "ardour/meter.h"
52 #include "ardour/midi_port.h"
53 #include "ardour/process_thread.h"
54 #include "ardour/port.h"
55 #include "ardour/port_set.h"
56 #include "ardour/session.h"
57 #include "ardour/timestamps.h"
58 #include "ardour/utils.h"
63 using namespace ARDOUR;
66 gint AudioEngine::m_meter_exit;
67 AudioEngine* AudioEngine::_instance = 0;
69 #define GET_PRIVATE_JACK_POINTER(j) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; }
70 #define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; }
72 AudioEngine::AudioEngine (string client_name, string session_uuid)
75 _instance = this; /* singleton */
77 session_remove_pending = false;
80 last_monitor_check = 0;
81 monitor_check_interval = INT32_MAX;
82 _processed_frames = 0;
87 _freewheeling = false;
91 g_atomic_int_set (&m_meter_exit, 0);
93 if (connect_to_jack (client_name, session_uuid)) {
94 throw NoBackendAvailable ();
97 Port::set_engine (this);
99 // Initialize parameter metadata (e.g. ranges)
100 Evoral::Parameter p(NullAutomation);
101 p = EventTypeMap::instance().new_parameter(NullAutomation);
102 p = EventTypeMap::instance().new_parameter(GainAutomation);
103 p = EventTypeMap::instance().new_parameter(PanAzimuthAutomation);
104 p = EventTypeMap::instance().new_parameter(PanElevationAutomation);
105 p = EventTypeMap::instance().new_parameter(PanWidthAutomation);
106 p = EventTypeMap::instance().new_parameter(PluginAutomation);
107 p = EventTypeMap::instance().new_parameter(SoloAutomation);
108 p = EventTypeMap::instance().new_parameter(MuteAutomation);
109 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
110 p = EventTypeMap::instance().new_parameter(MidiPgmChangeAutomation);
111 p = EventTypeMap::instance().new_parameter(MidiPitchBenderAutomation);
112 p = EventTypeMap::instance().new_parameter(MidiChannelPressureAutomation);
113 p = EventTypeMap::instance().new_parameter(FadeInAutomation);
114 p = EventTypeMap::instance().new_parameter(FadeOutAutomation);
115 p = EventTypeMap::instance().new_parameter(EnvelopeAutomation);
116 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
119 AudioEngine::~AudioEngine ()
122 Glib::Mutex::Lock tm (_process_lock);
123 session_removed.signal ();
126 jack_client_close (_jack);
130 stop_metering_thread ();
135 AudioEngine::jack() const
141 _thread_init_callback (void * /*arg*/)
143 /* make sure that anybody who needs to know about this thread
147 pthread_set_name (X_("audioengine"));
149 PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
150 PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
152 SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
154 MIDI::Port::set_process_thread (pthread_self());
158 ardour_jack_error (const char* msg)
160 error << "JACK: " << msg << endmsg;
164 AudioEngine::start ()
166 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
170 pframes_t blocksize = jack_get_buffer_size (_priv_jack);
173 BootMessage (_("Connect session to engine"));
175 _session->set_block_size (blocksize);
176 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
178 /* page in as much of the session process code as we
179 can before we really start running.
182 _session->process (blocksize);
183 _session->process (blocksize);
184 _session->process (blocksize);
185 _session->process (blocksize);
186 _session->process (blocksize);
187 _session->process (blocksize);
188 _session->process (blocksize);
189 _session->process (blocksize);
192 _processed_frames = 0;
193 last_monitor_check = 0;
195 if (jack_on_info_shutdown) {
196 jack_on_info_shutdown (_priv_jack, halted_info, this);
198 jack_on_shutdown (_priv_jack, halted, this);
200 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
201 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
202 // jack_set_process_callback (_priv_jack, _process_callback, this);
203 jack_set_process_thread (_priv_jack, _process_thread, this);
204 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
205 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
206 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
207 #ifdef HAVE_JACK_SESSION
208 if( jack_set_session_callback )
209 jack_set_session_callback (_priv_jack, _session_callback, this);
211 #if HAVE_JACK_NEW_LATENCY
212 if (jack_set_latency_callback) {
213 jack_set_latency_callback (_priv_jack, _latency_callback, this);
216 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
217 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
218 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
219 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
221 if (_session && _session->config.get_jack_time_master()) {
222 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
225 jack_set_error_function (ardour_jack_error);
227 if (jack_activate (_priv_jack) == 0) {
230 Running(); /* EMIT SIGNAL */
232 // error << _("cannot activate JACK client") << endmsg;
235 _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
237 jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
239 error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
241 _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
242 jack_port_unregister (_priv_jack, midi_port);
246 return _running ? 0 : -1;
250 AudioEngine::stop (bool forever)
252 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
256 disconnect_from_jack ();
258 jack_deactivate (_priv_jack);
259 Stopped(); /* EMIT SIGNAL */
260 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
265 stop_metering_thread ();
268 return _running ? -1 : 0;
273 AudioEngine::get_sync_offset (pframes_t& offset) const
276 #ifdef HAVE_JACK_VIDEO_SUPPORT
278 GET_PRIVATE_JACK_POINTER_RET (_jack, false);
283 (void) jack_transport_query (_priv_jack, &pos);
285 if (pos.valid & JackVideoFrameOffset) {
286 offset = pos.video_offset;
299 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
300 jack_position_t* pos, int new_position, void *arg)
302 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
306 AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
307 jack_position_t* pos, int new_position)
309 if (_jack && _session && _session->synced_to_jack()) {
310 _session->jack_timebase_callback (state, nframes, pos, new_position);
315 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
317 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
321 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
323 if (_jack && _session) {
324 return _session->jack_sync_callback (state, pos);
331 AudioEngine::_xrun_callback (void *arg)
333 AudioEngine* ae = static_cast<AudioEngine*> (arg);
334 if (ae->connected()) {
335 ae->Xrun (); /* EMIT SIGNAL */
340 #ifdef HAVE_JACK_SESSION
342 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
344 printf( "helo.... " );
345 AudioEngine* ae = static_cast<AudioEngine*> (arg);
346 if (ae->connected()) {
347 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
352 AudioEngine::_graph_order_callback (void *arg)
354 AudioEngine* ae = static_cast<AudioEngine*> (arg);
355 if (ae->connected()) {
356 ae->GraphReordered (); /* EMIT SIGNAL */
361 /** Wrapped which is called by JACK as its process callback. It is just
362 * here to get us back into C++ land by calling AudioEngine::process_callback()
363 * @param nframes Number of frames passed by JACK.
364 * @param arg User argument passed by JACK, which will be the AudioEngine*.
367 AudioEngine::_process_callback (pframes_t nframes, void *arg)
369 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
373 AudioEngine::_process_thread (void *arg)
375 return static_cast<AudioEngine *> (arg)->process_thread ();
379 AudioEngine::_freewheel_callback (int onoff, void *arg)
381 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
385 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
387 AudioEngine* ae = static_cast<AudioEngine*> (arg);
388 ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
392 AudioEngine::_latency_callback (jack_latency_callback_mode_t mode, void* arg)
394 return static_cast<AudioEngine *> (arg)->jack_latency_callback (mode);
398 AudioEngine::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg)
400 AudioEngine* ae = static_cast<AudioEngine*> (arg);
402 GET_PRIVATE_JACK_POINTER (ae->_jack);
404 jack_port_t* jack_port_a = jack_port_by_id (_priv_jack, id_a);
405 jack_port_t* jack_port_b = jack_port_by_id (_priv_jack, id_b);
410 boost::shared_ptr<Ports> pr = ae->ports.reader ();
411 Ports::iterator i = pr->begin ();
412 while (i != pr->end() && (port_a == 0 || port_b == 0)) {
413 if (jack_port_a == (*i)->_jack_port) {
415 } else if (jack_port_b == (*i)->_jack_port) {
421 ae->PortConnectedOrDisconnected (port_a, port_b, conn == 0 ? false : true); /* EMIT SIGNAL */
425 AudioEngine::split_cycle (pframes_t offset)
427 /* caller must hold process lock */
429 AudioPort::increment_port_offset (offset);
431 /* tell all Ports that we're going to start a new (split) cycle */
433 boost::shared_ptr<Ports> p = ports.reader();
435 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
436 (*i)->cycle_split ();
441 AudioEngine::finish_process_cycle (int /* status*/ )
443 GET_PRIVATE_JACK_POINTER(_jack);
444 jack_cycle_signal (_jack, 0);
448 AudioEngine::process_thread ()
450 /* JACK doesn't do this for us when we use the wait API
453 _thread_init_callback (0);
455 _main_thread = new ProcessThread;
458 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
459 pframes_t nframes = jack_cycle_wait (_jack);
461 if (process_callback (nframes)) {
462 cerr << "--- process\n";
466 finish_process_cycle (0);
472 /** Method called by JACK (via _process_callback) which says that there
473 * is work to be done.
474 * @param nframes Number of frames to process.
477 AudioEngine::process_callback (pframes_t nframes)
479 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
480 // CycleTimer ct ("AudioEngine::process");
481 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
483 /// The number of frames that will have been processed when we've finished
484 pframes_t next_processed_frames;
486 /* handle wrap around of total frames counter */
488 if (max_framepos - _processed_frames < nframes) {
489 next_processed_frames = nframes - (max_framepos - _processed_frames);
491 next_processed_frames = _processed_frames + nframes;
494 if (!tm.locked() || _session == 0) {
495 /* return having done nothing */
496 _processed_frames = next_processed_frames;
500 if (session_remove_pending) {
501 /* perform the actual session removal */
503 session_remove_pending = false;
504 session_removed.signal();
505 _processed_frames = next_processed_frames;
509 /* tell all relevant objects that we're starting a new cycle */
511 Delivery::CycleStart (nframes);
512 AudioPort::set_port_offset (0);
513 InternalReturn::CycleStart (nframes);
515 /* tell all Ports that we're starting a new cycle */
517 boost::shared_ptr<Ports> p = ports.reader();
519 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
520 (*i)->cycle_start (nframes);
523 /* test if we are freewheeling and there are freewheel signals connected.
524 ardour should act normally even when freewheeling unless /it/ is exporting */
527 if (_freewheeling && !Freewheel.empty()) {
528 /* emit the Freewheel signal and stop freewheeling in the event of trouble
530 boost::optional<int> r = Freewheel (nframes);
531 if (r.get_value_or (0)) {
532 jack_set_freewheel (_priv_jack, false);
537 _session->process (nframes);
547 _processed_frames = next_processed_frames;
551 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
553 boost::shared_ptr<Ports> p = ports.reader();
555 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
560 if (port->_last_monitor != (x = port->monitoring_input ())) {
561 port->_last_monitor = x;
562 /* XXX I think this is dangerous, due to
563 a likely mutex in the signal handlers ...
565 port->MonitorInputChanged (x); /* EMIT SIGNAL */
568 last_monitor_check = next_processed_frames;
571 if (_session->silent()) {
573 boost::shared_ptr<Ports> p = ports.reader();
575 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
579 if (port->sends_output()) {
580 port->get_buffer(nframes).silence(nframes);
587 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
588 (*i)->cycle_end (nframes);
591 _processed_frames = next_processed_frames;
596 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
598 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
602 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
604 _frame_rate = nframes;
605 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
607 /* check for monitor input change every 1/10th of second */
609 monitor_check_interval = nframes / 10;
610 last_monitor_check = 0;
613 _session->set_frame_rate (nframes);
616 SampleRateChanged (nframes); /* EMIT SIGNAL */
622 AudioEngine::jack_latency_callback (jack_latency_callback_mode_t mode)
625 _session->update_latency (mode == JackPlaybackLatency);
630 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
632 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
636 AudioEngine::jack_bufsize_callback (pframes_t nframes)
638 bool need_midi_size = true;
639 bool need_audio_size = true;
641 _buffer_size = nframes;
642 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
643 last_monitor_check = 0;
645 boost::shared_ptr<Ports> p = ports.reader();
647 /* crude guesses, see below where we try to get the right answers.
649 Note that our guess for MIDI deliberatey tries to overestimate
650 by a little. It would be nicer if we could get the actual
651 size from a port, but we have to use this estimate in the
652 event that there are no MIDI ports currently. If there are
653 the value will be adjusted below.
656 _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
657 _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
659 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
661 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
662 _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
663 need_audio_size = false;
667 if (need_midi_size && (*i)->type() == DataType::MIDI) {
668 _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
669 need_midi_size = false;
676 _session->set_block_size (_buffer_size);
683 AudioEngine::stop_metering_thread ()
685 if (m_meter_thread) {
686 g_atomic_int_set (&m_meter_exit, 1);
687 m_meter_thread->join ();
693 AudioEngine::start_metering_thread ()
695 if (m_meter_thread == 0) {
696 g_atomic_int_set (&m_meter_exit, 0);
697 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
698 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
703 AudioEngine::meter_thread ()
705 pthread_set_name (X_("meter"));
708 Glib::usleep (10000); /* 1/100th sec interval */
709 if (g_atomic_int_get(&m_meter_exit)) {
717 AudioEngine::set_session (Session *s)
719 Glib::Mutex::Lock pl (_process_lock);
721 SessionHandlePtr::set_session (s);
725 start_metering_thread ();
727 pframes_t blocksize = jack_get_buffer_size (_jack);
729 /* page in as much of the session process code as we
730 can before we really start running.
733 boost::shared_ptr<Ports> p = ports.reader();
735 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
736 (*i)->cycle_start (blocksize);
739 _session->process (blocksize);
740 _session->process (blocksize);
741 _session->process (blocksize);
742 _session->process (blocksize);
743 _session->process (blocksize);
744 _session->process (blocksize);
745 _session->process (blocksize);
746 _session->process (blocksize);
748 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
749 (*i)->cycle_end (blocksize);
755 AudioEngine::remove_session ()
757 Glib::Mutex::Lock lm (_process_lock);
761 stop_metering_thread ();
764 session_remove_pending = true;
765 session_removed.wait(_process_lock);
769 SessionHandlePtr::set_session (0);
776 AudioEngine::port_registration_failure (const std::string& portname)
778 GET_PRIVATE_JACK_POINTER (_jack);
779 string full_portname = jack_client_name;
780 full_portname += ':';
781 full_portname += portname;
784 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
788 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
790 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);
793 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
797 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
802 if (dtype == DataType::AUDIO) {
803 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
804 } else if (dtype == DataType::MIDI) {
805 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
807 throw PortRegistrationFailure("unable to create port (unknown type)");
810 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
811 size_t port_buffer_size = newport->raw_buffer_size(0);
812 if (port_buffer_size > old_buffer_size) {
813 old_buffer_size = port_buffer_size;
816 RCUWriter<Ports> writer (ports);
817 boost::shared_ptr<Ports> ps = writer.get_copy ();
818 ps->insert (ps->begin(), newport);
820 /* writer goes out of scope, forces update */
825 catch (PortRegistrationFailure& err) {
827 } catch (std::exception& e) {
828 throw PortRegistrationFailure(string_compose(
829 _("unable to create port: %1"), e.what()).c_str());
831 throw PortRegistrationFailure("unable to create port (unknown error)");
836 AudioEngine::register_input_port (DataType type, const string& portname)
838 return register_port (type, portname, true);
842 AudioEngine::register_output_port (DataType type, const string& portname)
844 return register_port (type, portname, false);
848 AudioEngine::unregister_port (Port& port)
850 /* caller must hold process lock */
853 /* probably happening when the engine has been halted by JACK,
854 in which case, there is nothing we can do here.
860 RCUWriter<Ports> writer (ports);
861 boost::shared_ptr<Ports> ps = writer.get_copy ();
863 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
871 /* writer goes out of scope, forces update */
878 AudioEngine::connect (const string& source, const string& destination)
884 fatal << _("connect called before engine was started") << endmsg;
891 string s = make_port_name_non_relative (source);
892 string d = make_port_name_non_relative (destination);
895 Port* src = get_port_by_name (s);
896 Port* dst = get_port_by_name (d);
899 ret = src->connect (d);
901 ret = dst->connect (s);
903 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
908 /* already exists - no error, no warning */
909 } else if (ret < 0) {
910 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
911 source, s, destination, d)
919 AudioEngine::disconnect (const string& source, const string& destination)
925 fatal << _("disconnect called before engine was started") << endmsg;
932 string s = make_port_name_non_relative (source);
933 string d = make_port_name_non_relative (destination);
935 Port* src = get_port_by_name (s);
936 Port* dst = get_port_by_name (d);
939 ret = src->disconnect (d);
941 ret = dst->disconnect (s);
943 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
950 AudioEngine::disconnect (Port& port)
952 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
956 fatal << _("disconnect called before engine was started") << endmsg;
963 return port.disconnect_all ();
967 AudioEngine::frame_rate () const
969 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
970 if (_frame_rate == 0) {
971 return (_frame_rate = jack_get_sample_rate (_priv_jack));
978 AudioEngine::raw_buffer_size (DataType t)
980 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
981 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
985 AudioEngine::frames_per_cycle () const
987 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
988 if (_buffer_size == 0) {
989 return (_buffer_size = jack_get_buffer_size (_jack));
995 /** @param name Full or short name of port
996 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
997 * so must not be deleted.
1000 AudioEngine::get_port_by_name (const string& portname)
1004 fatal << _("get_port_by_name() called before engine was started") << endmsg;
1011 if (portname.find_first_of (':') != string::npos) {
1012 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
1013 /* not an ardour: port */
1018 std::string const rel = make_port_name_relative (portname);
1020 boost::shared_ptr<Ports> pr = ports.reader();
1022 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1023 if (rel == (*i)->name()) {
1032 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1034 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1037 fatal << _("get_ports called before engine was started") << endmsg;
1043 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1047 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1049 /* called from jack shutdown handler */
1051 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1052 bool was_running = ae->_running;
1054 ae->stop_metering_thread ();
1056 ae->_running = false;
1057 ae->_buffer_size = 0;
1058 ae->_frame_rate = 0;
1062 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1064 case JackBackendError:
1065 ae->Halted(reason); /* EMIT SIGNAL */
1068 ae->Halted(""); /* EMIT SIGNAL */
1071 ae->Halted(""); /* EMIT SIGNAL */
1077 AudioEngine::halted (void *arg)
1079 cerr << "HALTED by JACK\n";
1081 /* called from jack shutdown handler */
1083 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1084 bool was_running = ae->_running;
1086 ae->stop_metering_thread ();
1088 ae->_running = false;
1089 ae->_buffer_size = 0;
1090 ae->_frame_rate = 0;
1094 ae->Halted(""); /* EMIT SIGNAL */
1095 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1100 AudioEngine::died ()
1102 /* called from a signal handler for SIGPIPE */
1104 stop_metering_thread ();
1113 AudioEngine::can_request_hardware_monitoring ()
1115 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1116 const char ** ports;
1118 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1128 AudioEngine::n_physical (unsigned long flags) const
1132 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1134 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1139 for (uint32_t i = 0; ports[i]; ++i) {
1140 if (!strstr (ports[i], "Midi-Through")) {
1141 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1142 c.set (t, c.get (t) + 1);
1152 AudioEngine::n_physical_inputs () const
1154 return n_physical (JackPortIsInput);
1158 AudioEngine::n_physical_outputs () const
1160 return n_physical (JackPortIsOutput);
1164 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1166 GET_PRIVATE_JACK_POINTER (_jack);
1167 const char ** ports;
1169 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1174 for (uint32_t i = 0; ports[i]; ++i) {
1175 if (strstr (ports[i], "Midi-Through")) {
1178 phy.push_back (ports[i]);
1184 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1185 * a physical input connector.
1188 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1190 get_physical (type, JackPortIsOutput, ins);
1193 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1194 * a physical output connector.
1197 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1199 get_physical (type, JackPortIsInput, outs);
1203 AudioEngine::update_total_latency (const Port& port)
1205 port.recompute_total_latency ();
1209 AudioEngine::transport_stop ()
1211 GET_PRIVATE_JACK_POINTER (_jack);
1212 jack_transport_stop (_priv_jack);
1216 AudioEngine::transport_start ()
1218 GET_PRIVATE_JACK_POINTER (_jack);
1219 jack_transport_start (_priv_jack);
1223 AudioEngine::transport_locate (framepos_t where)
1225 GET_PRIVATE_JACK_POINTER (_jack);
1226 // cerr << "tell JACK to locate to " << where << endl;
1227 jack_transport_locate (_priv_jack, where);
1230 AudioEngine::TransportState
1231 AudioEngine::transport_state ()
1233 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1234 jack_position_t pos;
1235 return (TransportState) jack_transport_query (_priv_jack, &pos);
1239 AudioEngine::reset_timebase ()
1241 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1243 if (_session->config.get_jack_time_master()) {
1244 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1246 return jack_release_timebase (_jack);
1253 AudioEngine::freewheel (bool onoff)
1255 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1257 if (onoff != _freewheeling) {
1258 return jack_set_freewheel (_priv_jack, onoff);
1261 /* already doing what has been asked for */
1267 AudioEngine::remove_all_ports ()
1269 /* process lock MUST be held */
1272 RCUWriter<Ports> writer (ports);
1273 boost::shared_ptr<Ports> ps = writer.get_copy ();
1275 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1282 /* clear dead wood list too */
1288 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1290 EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
1291 boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
1292 jack_options_t options = JackNullOption;
1293 jack_status_t status;
1294 const char *server_name = NULL;
1296 /* revert all environment settings back to whatever they were when ardour started
1300 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
1301 global_epa->restore ();
1304 jack_client_name = client_name; /* might be reset below */
1305 #ifdef HAVE_JACK_SESSION
1306 if (! session_uuid.empty())
1307 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1310 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1312 if (_jack == NULL) {
1313 // error message is not useful here
1317 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1319 if (status & JackNameNotUnique) {
1320 jack_client_name = jack_get_client_name (_priv_jack);
1327 AudioEngine::disconnect_from_jack ()
1329 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1332 stop_metering_thread ();
1336 Glib::Mutex::Lock lm (_process_lock);
1337 jack_client_close (_priv_jack);
1343 _raw_buffer_sizes.clear();
1347 Stopped(); /* EMIT SIGNAL */
1348 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1355 AudioEngine::reconnect_to_jack ()
1358 disconnect_from_jack ();
1359 /* XXX give jackd a chance */
1360 Glib::usleep (250000);
1363 if (connect_to_jack (jack_client_name, "")) {
1364 error << _("failed to connect to JACK") << endmsg;
1370 boost::shared_ptr<Ports> p = ports.reader ();
1372 for (i = p->begin(); i != p->end(); ++i) {
1373 if ((*i)->reestablish ()) {
1378 if (i != p->end()) {
1380 remove_all_ports ();
1384 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1386 MIDI::Manager::instance()->reestablish (_priv_jack);
1389 _session->reset_jack_connection (_priv_jack);
1390 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1391 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1394 last_monitor_check = 0;
1396 jack_on_shutdown (_priv_jack, halted, this);
1397 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1398 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1399 // jack_set_process_callback (_priv_jack, _process_callback, this);
1400 jack_set_process_thread (_priv_jack, _process_thread, this);
1401 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1402 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1403 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1404 #ifdef HAVE_JACK_SESSION
1405 if( jack_set_session_callback )
1406 jack_set_session_callback (_priv_jack, _session_callback, this);
1408 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1409 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1411 if (_session && _session->config.get_jack_time_master()) {
1412 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1415 if (jack_activate (_priv_jack) == 0) {
1422 /* re-establish connections */
1424 for (i = p->begin(); i != p->end(); ++i) {
1428 MIDI::Manager::instance()->reconnect ();
1430 Running (); /* EMIT SIGNAL*/
1432 start_metering_thread ();
1438 AudioEngine::request_buffer_size (pframes_t nframes)
1440 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1442 if (nframes == jack_get_buffer_size (_priv_jack)) {
1446 return jack_set_buffer_size (_priv_jack, nframes);
1450 AudioEngine::update_total_latencies ()
1452 GET_PRIVATE_JACK_POINTER (_jack);
1453 jack_recompute_total_latencies (_priv_jack);
1457 AudioEngine::make_port_name_relative (string portname)
1459 string::size_type len;
1460 string::size_type n;
1462 len = portname.length();
1464 for (n = 0; n < len; ++n) {
1465 if (portname[n] == ':') {
1470 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1471 return portname.substr (n+1);
1478 AudioEngine::make_port_name_non_relative (string portname)
1482 if (portname.find_first_of (':') != string::npos) {
1486 str = jack_client_name;
1494 AudioEngine::is_realtime () const
1496 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1497 return jack_is_realtime (_priv_jack);
1501 AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
1503 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1504 ThreadData* td = new ThreadData (this, f, stacksize);
1506 if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack),
1507 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1515 AudioEngine::_start_process_thread (void* arg)
1517 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1518 boost::function<void()> f = td->f;