2 Copyright (C) 2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include <glibmm/timer.h>
28 #include <jack/jack.h>
29 #include <jack/thread.h>
31 #include "pbd/pthread_utils.h"
32 #include "pbd/stacktrace.h"
33 #include "pbd/unknown_type.h"
36 #include "midi++/port.h"
37 #include "midi++/mmc.h"
38 #include "midi++/manager.h"
40 #include "ardour/amp.h"
41 #include "ardour/audio_port.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/buffer.h"
44 #include "ardour/buffer_set.h"
45 #include "ardour/cycle_timer.h"
46 #include "ardour/delivery.h"
47 #include "ardour/event_type_map.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/io.h"
50 #include "ardour/meter.h"
51 #include "ardour/midi_port.h"
52 #include "ardour/process_thread.h"
53 #include "ardour/port.h"
54 #include "ardour/port_set.h"
55 #include "ardour/session.h"
56 #include "ardour/timestamps.h"
57 #include "ardour/utils.h"
62 using namespace ARDOUR;
65 gint AudioEngine::m_meter_exit;
66 AudioEngine* AudioEngine::_instance = 0;
68 #define GET_PRIVATE_JACK_POINTER(j) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; }
69 #define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; }
71 AudioEngine::AudioEngine (string client_name, string session_uuid)
74 _instance = this; /* singleton */
76 session_remove_pending = false;
79 last_monitor_check = 0;
80 monitor_check_interval = INT32_MAX;
81 _processed_frames = 0;
86 _freewheeling = false;
90 g_atomic_int_set (&m_meter_exit, 0);
92 if (connect_to_jack (client_name, session_uuid)) {
93 throw NoBackendAvailable ();
96 Port::set_engine (this);
98 // Initialize parameter metadata (e.g. ranges)
99 Evoral::Parameter p(NullAutomation);
100 p = EventTypeMap::instance().new_parameter(NullAutomation);
101 p = EventTypeMap::instance().new_parameter(GainAutomation);
102 p = EventTypeMap::instance().new_parameter(PanAutomation);
103 p = EventTypeMap::instance().new_parameter(PluginAutomation);
104 p = EventTypeMap::instance().new_parameter(SoloAutomation);
105 p = EventTypeMap::instance().new_parameter(MuteAutomation);
106 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
107 p = EventTypeMap::instance().new_parameter(MidiPgmChangeAutomation);
108 p = EventTypeMap::instance().new_parameter(MidiPitchBenderAutomation);
109 p = EventTypeMap::instance().new_parameter(MidiChannelPressureAutomation);
110 p = EventTypeMap::instance().new_parameter(FadeInAutomation);
111 p = EventTypeMap::instance().new_parameter(FadeOutAutomation);
112 p = EventTypeMap::instance().new_parameter(EnvelopeAutomation);
113 p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
116 AudioEngine::~AudioEngine ()
119 Glib::Mutex::Lock tm (_process_lock);
120 session_removed.signal ();
123 jack_client_close (_jack);
127 stop_metering_thread ();
132 AudioEngine::jack() const
138 _thread_init_callback (void * /*arg*/)
140 /* make sure that anybody who needs to know about this thread
144 pthread_set_name (X_("audioengine"));
146 PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
147 PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
149 SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
151 MIDI::Port::set_process_thread (pthread_self());
154 typedef void (*_JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);
156 static void (*on_info_shutdown)(jack_client_t*, _JackInfoShutdownCallback, void *);
157 extern void jack_on_info_shutdown (jack_client_t*, _JackInfoShutdownCallback, void *) __attribute__((weak));
159 static void check_jack_symbols () __attribute__((constructor));
161 void check_jack_symbols ()
163 /* use weak linking to see if we really have various late-model JACK function */
164 on_info_shutdown = jack_on_info_shutdown;
168 ardour_jack_error (const char* msg)
170 error << "JACK: " << msg << endmsg;
174 AudioEngine::start ()
176 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
180 pframes_t blocksize = jack_get_buffer_size (_priv_jack);
183 BootMessage (_("Connect session to engine"));
185 _session->set_block_size (blocksize);
186 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
188 /* page in as much of the session process code as we
189 can before we really start running.
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);
199 _session->process (blocksize);
202 _processed_frames = 0;
203 last_monitor_check = 0;
205 if (on_info_shutdown) {
206 jack_on_info_shutdown (_priv_jack, halted_info, this);
208 jack_on_shutdown (_priv_jack, halted, this);
210 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
211 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
212 // jack_set_process_callback (_priv_jack, _process_callback, this);
213 jack_set_process_thread (_priv_jack, _process_thread, this);
214 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
215 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
216 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
217 #ifdef HAVE_JACK_SESSION
218 if( jack_set_session_callback )
219 jack_set_session_callback (_priv_jack, _session_callback, this);
221 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
222 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
223 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
224 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
226 if (_session && _session->config.get_jack_time_master()) {
227 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
230 jack_set_error_function (ardour_jack_error);
232 if (jack_activate (_priv_jack) == 0) {
235 Running(); /* EMIT SIGNAL */
237 // error << _("cannot activate JACK client") << endmsg;
240 _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
242 jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
244 error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
246 _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
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 */
270 stop_metering_thread ();
273 return _running ? -1 : 0;
278 AudioEngine::get_sync_offset (pframes_t& offset) const
281 #ifdef HAVE_JACK_VIDEO_SUPPORT
283 GET_PRIVATE_JACK_POINTER_RET (_jack, false);
288 (void) jack_transport_query (_priv_jack, &pos);
290 if (pos.valid & JackVideoFrameOffset) {
291 offset = pos.video_offset;
304 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
305 jack_position_t* pos, int new_position, void *arg)
307 static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
311 AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
312 jack_position_t* pos, int new_position)
314 if (_jack && _session && _session->synced_to_jack()) {
315 _session->jack_timebase_callback (state, nframes, pos, new_position);
320 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
322 return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
326 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
328 if (_jack && _session) {
329 return _session->jack_sync_callback (state, pos);
336 AudioEngine::_xrun_callback (void *arg)
338 AudioEngine* ae = static_cast<AudioEngine*> (arg);
339 if (ae->connected()) {
340 ae->Xrun (); /* EMIT SIGNAL */
345 #ifdef HAVE_JACK_SESSION
347 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
349 printf( "helo.... " );
350 AudioEngine* ae = static_cast<AudioEngine*> (arg);
351 if (ae->connected()) {
352 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
357 AudioEngine::_graph_order_callback (void *arg)
359 AudioEngine* ae = static_cast<AudioEngine*> (arg);
360 if (ae->connected()) {
361 ae->GraphReordered (); /* EMIT SIGNAL */
366 /** Wrapped which is called by JACK as its process callback. It is just
367 * here to get us back into C++ land by calling AudioEngine::process_callback()
368 * @param nframes Number of frames passed by JACK.
369 * @param arg User argument passed by JACK, which will be the AudioEngine*.
372 AudioEngine::_process_callback (pframes_t nframes, void *arg)
374 return static_cast<AudioEngine *> (arg)->process_callback (nframes);
378 AudioEngine::_process_thread (void *arg)
380 return static_cast<AudioEngine *> (arg)->process_thread ();
384 AudioEngine::_freewheel_callback (int onoff, void *arg)
386 static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
390 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
392 AudioEngine* ae = static_cast<AudioEngine*> (arg);
393 ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
397 AudioEngine::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg)
399 AudioEngine* ae = static_cast<AudioEngine*> (arg);
401 GET_PRIVATE_JACK_POINTER (ae->_jack);
403 jack_port_t* jack_port_a = jack_port_by_id (_priv_jack, id_a);
404 jack_port_t* jack_port_b = jack_port_by_id (_priv_jack, id_b);
409 boost::shared_ptr<Ports> pr = ae->ports.reader ();
410 Ports::iterator i = pr->begin ();
411 while (i != pr->end() && (port_a == 0 || port_b == 0)) {
412 if (jack_port_a == (*i)->_jack_port) {
414 } else if (jack_port_b == (*i)->_jack_port) {
420 ae->PortConnectedOrDisconnected (port_a, port_b, conn == 0 ? false : true); /* EMIT SIGNAL */
424 AudioEngine::split_cycle (pframes_t offset)
426 /* caller must hold process lock */
428 AudioPort::increment_port_offset (offset);
430 /* tell all Ports that we're going to start a new (split) cycle */
432 boost::shared_ptr<Ports> p = ports.reader();
434 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
435 (*i)->cycle_split ();
440 AudioEngine::finish_process_cycle (int /* status*/ )
442 GET_PRIVATE_JACK_POINTER(_jack);
443 jack_cycle_signal (_jack, 0);
447 AudioEngine::process_thread ()
449 /* JACK doesn't do this for us when we use the wait API
452 _thread_init_callback (0);
454 _main_thread = new ProcessThread;
457 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
458 pframes_t nframes = jack_cycle_wait (_jack);
460 if (process_callback (nframes)) {
461 cerr << "--- process\n";
465 finish_process_cycle (0);
471 /** Method called by JACK (via _process_callback) which says that there
472 * is work to be done.
473 * @param nframes Number of frames to process.
476 AudioEngine::process_callback (pframes_t nframes)
478 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
479 // CycleTimer ct ("AudioEngine::process");
480 Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
482 /// The number of frames that will have been processed when we've finished
483 pframes_t next_processed_frames;
485 /* handle wrap around of total frames counter */
487 if (max_framepos - _processed_frames < nframes) {
488 next_processed_frames = nframes - (max_framepos - _processed_frames);
490 next_processed_frames = _processed_frames + nframes;
493 if (!tm.locked() || _session == 0) {
494 /* return having done nothing */
495 _processed_frames = next_processed_frames;
499 if (session_remove_pending) {
500 /* perform the actual session removal */
502 session_remove_pending = false;
503 session_removed.signal();
504 _processed_frames = next_processed_frames;
508 /* tell all relevant objects that we're starting a new cycle */
510 Delivery::CycleStart (nframes);
511 AudioPort::set_port_offset (0);
512 InternalReturn::CycleStart (nframes);
514 /* tell all Ports that we're starting a new cycle */
516 boost::shared_ptr<Ports> p = ports.reader();
518 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
519 (*i)->cycle_start (nframes);
522 /* test if we are freewheeling and there are freewheel signals connected.
523 ardour should act normally even when freewheeling unless /it/ is exporting */
526 if (_freewheeling && !Freewheel.empty()) {
527 /* emit the Freewheel signal and stop freewheeling in the event of trouble
529 boost::optional<int> r = Freewheel (nframes);
530 if (r.get_value_or (0)) {
531 jack_set_freewheel (_priv_jack, false);
536 _session->process (nframes);
546 _processed_frames = next_processed_frames;
550 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
552 boost::shared_ptr<Ports> p = ports.reader();
554 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
559 if (port->_last_monitor != (x = port->monitoring_input ())) {
560 port->_last_monitor = x;
561 /* XXX I think this is dangerous, due to
562 a likely mutex in the signal handlers ...
564 port->MonitorInputChanged (x); /* EMIT SIGNAL */
567 last_monitor_check = next_processed_frames;
570 if (_session->silent()) {
572 boost::shared_ptr<Ports> p = ports.reader();
574 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
578 if (port->sends_output()) {
579 port->get_buffer(nframes).silence(nframes);
586 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
587 (*i)->cycle_end (nframes);
590 _processed_frames = next_processed_frames;
595 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
597 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
601 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
603 _frame_rate = nframes;
604 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
606 /* check for monitor input change every 1/10th of second */
608 monitor_check_interval = nframes / 10;
609 last_monitor_check = 0;
612 _session->set_frame_rate (nframes);
615 SampleRateChanged (nframes); /* EMIT SIGNAL */
621 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
623 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
627 AudioEngine::jack_bufsize_callback (pframes_t nframes)
629 bool need_midi_size = true;
630 bool need_audio_size = true;
632 _buffer_size = nframes;
633 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
634 last_monitor_check = 0;
636 boost::shared_ptr<Ports> p = ports.reader();
638 /* crude guesses, see below where we try to get the right answers.
640 Note that our guess for MIDI deliberatey tries to overestimate
641 by a little. It would be nicer if we could get the actual
642 size from a port, but we have to use this estimate in the
643 event that there are no MIDI ports currently. If there are
644 the value will be adjusted below.
647 _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
648 _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
650 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
652 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
653 _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
654 need_audio_size = false;
658 if (need_midi_size && (*i)->type() == DataType::MIDI) {
659 _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
660 need_midi_size = false;
667 _session->set_block_size (_buffer_size);
674 AudioEngine::stop_metering_thread ()
676 if (m_meter_thread) {
677 g_atomic_int_set (&m_meter_exit, 1);
678 m_meter_thread->join ();
684 AudioEngine::start_metering_thread ()
686 if (m_meter_thread == 0) {
687 g_atomic_int_set (&m_meter_exit, 0);
688 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
689 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
694 AudioEngine::meter_thread ()
696 pthread_set_name (X_("meter"));
699 Glib::usleep (10000); /* 1/100th sec interval */
700 if (g_atomic_int_get(&m_meter_exit)) {
708 AudioEngine::set_session (Session *s)
710 Glib::Mutex::Lock pl (_process_lock);
712 SessionHandlePtr::set_session (s);
716 start_metering_thread ();
718 pframes_t blocksize = jack_get_buffer_size (_jack);
720 /* page in as much of the session process code as we
721 can before we really start running.
724 boost::shared_ptr<Ports> p = ports.reader();
726 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
727 (*i)->cycle_start (blocksize);
730 _session->process (blocksize);
731 _session->process (blocksize);
732 _session->process (blocksize);
733 _session->process (blocksize);
734 _session->process (blocksize);
735 _session->process (blocksize);
736 _session->process (blocksize);
737 _session->process (blocksize);
739 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
740 (*i)->cycle_end (blocksize);
746 AudioEngine::remove_session ()
748 Glib::Mutex::Lock lm (_process_lock);
752 stop_metering_thread ();
755 session_remove_pending = true;
756 session_removed.wait(_process_lock);
760 SessionHandlePtr::set_session (0);
767 AudioEngine::port_registration_failure (const std::string& portname)
769 GET_PRIVATE_JACK_POINTER (_jack);
770 string full_portname = jack_client_name;
771 full_portname += ':';
772 full_portname += portname;
775 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
779 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
781 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);
784 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
788 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
793 if (dtype == DataType::AUDIO) {
794 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
795 } else if (dtype == DataType::MIDI) {
796 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
798 throw PortRegistrationFailure("unable to create port (unknown type)");
801 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
802 size_t port_buffer_size = newport->raw_buffer_size(0);
803 if (port_buffer_size > old_buffer_size) {
804 old_buffer_size = port_buffer_size;
807 RCUWriter<Ports> writer (ports);
808 boost::shared_ptr<Ports> ps = writer.get_copy ();
809 ps->insert (ps->begin(), newport);
811 /* writer goes out of scope, forces update */
816 catch (PortRegistrationFailure& err) {
818 } catch (std::exception& e) {
819 throw PortRegistrationFailure(string_compose(
820 _("unable to create port: %1"), e.what()).c_str());
822 throw PortRegistrationFailure("unable to create port (unknown error)");
827 AudioEngine::register_input_port (DataType type, const string& portname)
829 return register_port (type, portname, true);
833 AudioEngine::register_output_port (DataType type, const string& portname)
835 return register_port (type, portname, false);
839 AudioEngine::unregister_port (Port& port)
841 /* caller must hold process lock */
844 /* probably happening when the engine has been halted by JACK,
845 in which case, there is nothing we can do here.
851 RCUWriter<Ports> writer (ports);
852 boost::shared_ptr<Ports> ps = writer.get_copy ();
854 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
862 /* writer goes out of scope, forces update */
869 AudioEngine::connect (const string& source, const string& destination)
875 fatal << _("connect called before engine was started") << endmsg;
882 string s = make_port_name_non_relative (source);
883 string d = make_port_name_non_relative (destination);
886 Port* src = get_port_by_name (s);
887 Port* dst = get_port_by_name (d);
890 ret = src->connect (d);
892 ret = dst->connect (s);
894 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
899 /* already exists - no error, no warning */
900 } else if (ret < 0) {
901 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
902 source, s, destination, d)
910 AudioEngine::disconnect (const string& source, const string& destination)
916 fatal << _("disconnect called before engine was started") << endmsg;
923 string s = make_port_name_non_relative (source);
924 string d = make_port_name_non_relative (destination);
926 Port* src = get_port_by_name (s);
927 Port* dst = get_port_by_name (d);
930 ret = src->disconnect (d);
932 ret = dst->disconnect (s);
934 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
941 AudioEngine::disconnect (Port& port)
943 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
947 fatal << _("disconnect called before engine was started") << endmsg;
954 return port.disconnect_all ();
958 AudioEngine::frame_rate () const
960 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
961 if (_frame_rate == 0) {
962 return (_frame_rate = jack_get_sample_rate (_priv_jack));
969 AudioEngine::raw_buffer_size (DataType t)
971 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
972 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
976 AudioEngine::frames_per_cycle () const
978 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
979 if (_buffer_size == 0) {
980 return (_buffer_size = jack_get_buffer_size (_jack));
986 /** @param name Full or short name of port
987 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
988 * so must not be deleted.
991 AudioEngine::get_port_by_name (const string& portname)
995 fatal << _("get_port_by_name() called before engine was started") << endmsg;
1002 if (portname.find_first_of (':') != string::npos) {
1003 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
1004 /* not an ardour: port */
1009 std::string const rel = make_port_name_relative (portname);
1011 boost::shared_ptr<Ports> pr = ports.reader();
1013 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1014 if (rel == (*i)->name()) {
1023 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1025 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1028 fatal << _("get_ports called before engine was started") << endmsg;
1034 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1038 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1040 /* called from jack shutdown handler */
1042 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1043 bool was_running = ae->_running;
1045 ae->stop_metering_thread ();
1047 ae->_running = false;
1048 ae->_buffer_size = 0;
1049 ae->_frame_rate = 0;
1053 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1055 case JackBackendError:
1056 ae->Halted(reason); /* EMIT SIGNAL */
1059 ae->Halted(""); /* EMIT SIGNAL */
1062 ae->Halted(""); /* EMIT SIGNAL */
1068 AudioEngine::halted (void *arg)
1070 cerr << "HALTED by JACK\n";
1072 /* called from jack shutdown handler */
1074 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1075 bool was_running = ae->_running;
1077 ae->stop_metering_thread ();
1079 ae->_running = false;
1080 ae->_buffer_size = 0;
1081 ae->_frame_rate = 0;
1085 ae->Halted(""); /* EMIT SIGNAL */
1086 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1091 AudioEngine::died ()
1093 /* called from a signal handler for SIGPIPE */
1095 stop_metering_thread ();
1104 AudioEngine::can_request_hardware_monitoring ()
1106 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1107 const char ** ports;
1109 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1119 AudioEngine::n_physical (unsigned long flags) const
1123 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1125 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1130 for (uint32_t i = 0; ports[i]; ++i) {
1131 if (!strstr (ports[i], "Midi-Through")) {
1132 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1133 c.set (t, c.get (t) + 1);
1143 AudioEngine::n_physical_inputs () const
1145 return n_physical (JackPortIsInput);
1149 AudioEngine::n_physical_outputs () const
1151 return n_physical (JackPortIsOutput);
1155 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1157 GET_PRIVATE_JACK_POINTER (_jack);
1158 const char ** ports;
1160 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1165 for (uint32_t i = 0; ports[i]; ++i) {
1166 if (strstr (ports[i], "Midi-Through")) {
1169 phy.push_back (ports[i]);
1175 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1176 * a physical input connector.
1179 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1181 get_physical (type, JackPortIsOutput, ins);
1184 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1185 * a physical output connector.
1188 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1190 get_physical (type, JackPortIsInput, outs);
1194 AudioEngine::update_total_latency (const Port& port)
1196 port.recompute_total_latency ();
1200 AudioEngine::transport_stop ()
1202 GET_PRIVATE_JACK_POINTER (_jack);
1203 jack_transport_stop (_priv_jack);
1207 AudioEngine::transport_start ()
1209 GET_PRIVATE_JACK_POINTER (_jack);
1210 jack_transport_start (_priv_jack);
1214 AudioEngine::transport_locate (framepos_t where)
1216 GET_PRIVATE_JACK_POINTER (_jack);
1217 // cerr << "tell JACK to locate to " << where << endl;
1218 jack_transport_locate (_priv_jack, where);
1221 AudioEngine::TransportState
1222 AudioEngine::transport_state ()
1224 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1225 jack_position_t pos;
1226 return (TransportState) jack_transport_query (_priv_jack, &pos);
1230 AudioEngine::reset_timebase ()
1232 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1234 if (_session->config.get_jack_time_master()) {
1235 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1237 return jack_release_timebase (_jack);
1244 AudioEngine::freewheel (bool onoff)
1246 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1248 if (onoff != _freewheeling) {
1249 return jack_set_freewheel (_priv_jack, onoff);
1252 /* already doing what has been asked for */
1258 AudioEngine::remove_all_ports ()
1260 /* process lock MUST be held */
1263 RCUWriter<Ports> writer (ports);
1264 boost::shared_ptr<Ports> ps = writer.get_copy ();
1266 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1273 /* clear dead wood list too */
1279 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1281 EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
1282 boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
1283 jack_options_t options = JackNullOption;
1284 jack_status_t status;
1285 const char *server_name = NULL;
1287 /* revert all environment settings back to whatever they were when ardour started
1291 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
1292 global_epa->restore ();
1295 jack_client_name = client_name; /* might be reset below */
1296 #ifdef HAVE_JACK_SESSION
1297 if (! session_uuid.empty())
1298 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1301 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1303 if (_jack == NULL) {
1304 // error message is not useful here
1308 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1310 if (status & JackNameNotUnique) {
1311 jack_client_name = jack_get_client_name (_priv_jack);
1318 AudioEngine::disconnect_from_jack ()
1320 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1323 stop_metering_thread ();
1327 Glib::Mutex::Lock lm (_process_lock);
1328 jack_client_close (_priv_jack);
1334 _raw_buffer_sizes.clear();
1338 Stopped(); /* EMIT SIGNAL */
1339 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1346 AudioEngine::reconnect_to_jack ()
1349 disconnect_from_jack ();
1350 /* XXX give jackd a chance */
1351 Glib::usleep (250000);
1354 if (connect_to_jack (jack_client_name, "")) {
1355 error << _("failed to connect to JACK") << endmsg;
1361 boost::shared_ptr<Ports> p = ports.reader ();
1363 for (i = p->begin(); i != p->end(); ++i) {
1364 if ((*i)->reestablish ()) {
1369 if (i != p->end()) {
1371 remove_all_ports ();
1375 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1377 MIDI::Manager::instance()->reestablish (_priv_jack);
1380 _session->reset_jack_connection (_priv_jack);
1381 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1382 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1385 last_monitor_check = 0;
1387 jack_on_shutdown (_priv_jack, halted, this);
1388 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1389 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1390 // jack_set_process_callback (_priv_jack, _process_callback, this);
1391 jack_set_process_thread (_priv_jack, _process_thread, this);
1392 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1393 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1394 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1395 #ifdef HAVE_JACK_SESSION
1396 if( jack_set_session_callback )
1397 jack_set_session_callback (_priv_jack, _session_callback, this);
1399 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1400 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1402 if (_session && _session->config.get_jack_time_master()) {
1403 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1406 if (jack_activate (_priv_jack) == 0) {
1413 /* re-establish connections */
1415 for (i = p->begin(); i != p->end(); ++i) {
1419 MIDI::Manager::instance()->reconnect ();
1421 Running (); /* EMIT SIGNAL*/
1423 start_metering_thread ();
1429 AudioEngine::request_buffer_size (pframes_t nframes)
1431 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1433 if (nframes == jack_get_buffer_size (_priv_jack)) {
1437 return jack_set_buffer_size (_priv_jack, nframes);
1441 AudioEngine::update_total_latencies ()
1443 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1444 GET_PRIVATE_JACK_POINTER (_jack);
1445 jack_recompute_total_latencies (_priv_jack);
1450 AudioEngine::make_port_name_relative (string portname)
1452 string::size_type len;
1453 string::size_type n;
1455 len = portname.length();
1457 for (n = 0; n < len; ++n) {
1458 if (portname[n] == ':') {
1463 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1464 return portname.substr (n+1);
1471 AudioEngine::make_port_name_non_relative (string portname)
1475 if (portname.find_first_of (':') != string::npos) {
1479 str = jack_client_name;
1487 AudioEngine::is_realtime () const
1489 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1490 return jack_is_realtime (_priv_jack);
1494 AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
1496 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1497 ThreadData* td = new ThreadData (this, f, stacksize);
1499 if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack),
1500 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1508 AudioEngine::_start_process_thread (void* arg)
1510 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1511 boost::function<void()> f = td->f;