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::set_jack_callbacks ()
166 GET_PRIVATE_JACK_POINTER (_jack);
168 if (jack_on_info_shutdown) {
169 jack_on_info_shutdown (_priv_jack, halted_info, this);
171 jack_on_shutdown (_priv_jack, halted, this);
174 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
175 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
176 jack_set_process_thread (_priv_jack, _process_thread, this);
177 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
178 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
179 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
180 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
181 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
182 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
183 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
185 if (_session && _session->config.get_jack_time_master()) {
186 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
189 #ifdef HAVE_JACK_SESSION
190 if( jack_set_session_callback)
191 jack_set_session_callback (_priv_jack, _session_callback, this);
194 if (jack_set_latency_callback) {
195 jack_set_latency_callback (_priv_jack, _latency_callback, this);
198 jack_set_error_function (ardour_jack_error);
202 AudioEngine::start ()
204 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
210 if (jack_port_type_get_buffer_size) {
211 blocksize = jack_port_type_get_buffer_size (_priv_jack, JACK_DEFAULT_AUDIO_TYPE);
213 warning << _("This version of JACK is old - you should upgrade to a newer version that supports jack_port_type_get_buffer_size()") << endmsg;
214 blocksize = jack_get_buffer_size (_priv_jack);
218 BootMessage (_("Connect session to engine"));
219 _session->set_block_size (blocksize);
220 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
223 _processed_frames = 0;
224 last_monitor_check = 0;
226 set_jack_callbacks ();
228 /* a proxy for whether jack_activate() will definitely call the buffer size
229 * callback. with older versions of JACK, this function symbol will be null.
230 * this is reliable, but not clean.
233 if (!jack_port_type_get_buffer_size) {
234 jack_bufsize_callback (blocksize);
237 if (jack_activate (_priv_jack) == 0) {
240 Running(); /* EMIT SIGNAL */
242 // error << _("cannot activate JACK client") << endmsg;
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 Port::increment_global_port_buffer_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 Port::set_global_port_buffer_offset (0);
513 Port::set_cycle_framecnt (nframes);
514 InternalReturn::CycleStart (nframes);
516 /* tell all Ports that we're starting a new cycle */
518 boost::shared_ptr<Ports> p = ports.reader();
520 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
521 (*i)->cycle_start (nframes);
524 /* test if we are freewheeling and there are freewheel signals connected.
525 ardour should act normally even when freewheeling unless /it/ is exporting */
528 if (_freewheeling && !Freewheel.empty()) {
529 /* emit the Freewheel signal and stop freewheeling in the event of trouble
531 boost::optional<int> r = Freewheel (nframes);
532 if (r.get_value_or (0)) {
533 jack_set_freewheel (_priv_jack, false);
538 _session->process (nframes);
548 _processed_frames = next_processed_frames;
552 if (last_monitor_check + monitor_check_interval < next_processed_frames) {
554 boost::shared_ptr<Ports> p = ports.reader();
556 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
561 if (port->last_monitor() != (x = port->monitoring_input ())) {
562 port->set_last_monitor (x);
563 /* XXX I think this is dangerous, due to
564 a likely mutex in the signal handlers ...
566 port->MonitorInputChanged (x); /* EMIT SIGNAL */
569 last_monitor_check = next_processed_frames;
572 if (_session->silent()) {
574 boost::shared_ptr<Ports> p = ports.reader();
576 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
580 if (port->sends_output()) {
581 port->get_buffer(nframes).silence(nframes);
588 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
589 (*i)->cycle_end (nframes);
592 _processed_frames = next_processed_frames;
597 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
599 return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
603 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
605 _frame_rate = nframes;
606 _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
608 /* check for monitor input change every 1/10th of second */
610 monitor_check_interval = nframes / 10;
611 last_monitor_check = 0;
614 _session->set_frame_rate (nframes);
617 SampleRateChanged (nframes); /* EMIT SIGNAL */
623 AudioEngine::jack_latency_callback (jack_latency_callback_mode_t mode)
626 _session->update_latency (mode == JackPlaybackLatency);
631 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
633 return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
637 AudioEngine::jack_bufsize_callback (pframes_t nframes)
639 /* if the size has not changed, this should be a no-op */
641 if (nframes == _buffer_size) {
645 GET_PRIVATE_JACK_POINTER_RET (_jack, 1);
647 _buffer_size = nframes;
648 _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
649 last_monitor_check = 0;
651 _raw_buffer_sizes[DataType::AUDIO] = jack_port_type_get_buffer_size (_priv_jack, JACK_DEFAULT_AUDIO_TYPE);
652 _raw_buffer_sizes[DataType::MIDI] = jack_port_type_get_buffer_size (_priv_jack, JACK_DEFAULT_MIDI_TYPE);
654 boost::shared_ptr<Ports> p = ports.reader();
656 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
661 _session->set_block_size (_buffer_size);
668 AudioEngine::stop_metering_thread ()
670 if (m_meter_thread) {
671 g_atomic_int_set (&m_meter_exit, 1);
672 m_meter_thread->join ();
678 AudioEngine::start_metering_thread ()
680 if (m_meter_thread == 0) {
681 g_atomic_int_set (&m_meter_exit, 0);
682 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
683 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
688 AudioEngine::meter_thread ()
690 pthread_set_name (X_("meter"));
693 Glib::usleep (10000); /* 1/100th sec interval */
694 if (g_atomic_int_get(&m_meter_exit)) {
702 AudioEngine::set_session (Session *s)
704 Glib::Mutex::Lock pl (_process_lock);
706 SessionHandlePtr::set_session (s);
710 start_metering_thread ();
712 pframes_t blocksize = jack_get_buffer_size (_jack);
714 /* page in as much of the session process code as we
715 can before we really start running.
718 boost::shared_ptr<Ports> p = ports.reader();
720 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
721 (*i)->cycle_start (blocksize);
724 _session->process (blocksize);
725 _session->process (blocksize);
726 _session->process (blocksize);
727 _session->process (blocksize);
728 _session->process (blocksize);
729 _session->process (blocksize);
730 _session->process (blocksize);
731 _session->process (blocksize);
733 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
734 (*i)->cycle_end (blocksize);
740 AudioEngine::remove_session ()
742 Glib::Mutex::Lock lm (_process_lock);
746 stop_metering_thread ();
749 session_remove_pending = true;
750 session_removed.wait(_process_lock);
754 SessionHandlePtr::set_session (0);
761 AudioEngine::port_registration_failure (const std::string& portname)
763 GET_PRIVATE_JACK_POINTER (_jack);
764 string full_portname = jack_client_name;
765 full_portname += ':';
766 full_portname += portname;
769 jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
773 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
775 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);
778 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
782 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
787 if (dtype == DataType::AUDIO) {
788 newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
789 } else if (dtype == DataType::MIDI) {
790 newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
792 throw PortRegistrationFailure("unable to create port (unknown type)");
795 size_t& old_buffer_size = _raw_buffer_sizes[newport->type()];
796 size_t port_buffer_size = newport->raw_buffer_size(0);
797 if (port_buffer_size > old_buffer_size) {
798 old_buffer_size = port_buffer_size;
801 RCUWriter<Ports> writer (ports);
802 boost::shared_ptr<Ports> ps = writer.get_copy ();
803 ps->insert (ps->begin(), newport);
805 /* writer goes out of scope, forces update */
810 catch (PortRegistrationFailure& err) {
812 } catch (std::exception& e) {
813 throw PortRegistrationFailure(string_compose(
814 _("unable to create port: %1"), e.what()).c_str());
816 throw PortRegistrationFailure("unable to create port (unknown error)");
821 AudioEngine::register_input_port (DataType type, const string& portname)
823 return register_port (type, portname, true);
827 AudioEngine::register_output_port (DataType type, const string& portname)
829 return register_port (type, portname, false);
833 AudioEngine::unregister_port (Port& port)
835 /* caller must hold process lock */
838 /* probably happening when the engine has been halted by JACK,
839 in which case, there is nothing we can do here.
845 RCUWriter<Ports> writer (ports);
846 boost::shared_ptr<Ports> ps = writer.get_copy ();
848 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
856 /* writer goes out of scope, forces update */
863 AudioEngine::connect (const string& source, const string& destination)
869 fatal << _("connect called before engine was started") << endmsg;
876 string s = make_port_name_non_relative (source);
877 string d = make_port_name_non_relative (destination);
880 Port* src = get_port_by_name (s);
881 Port* dst = get_port_by_name (d);
884 ret = src->connect (d);
886 ret = dst->connect (s);
888 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
893 /* already exists - no error, no warning */
894 } else if (ret < 0) {
895 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
896 source, s, destination, d)
904 AudioEngine::disconnect (const string& source, const string& destination)
910 fatal << _("disconnect called before engine was started") << endmsg;
917 string s = make_port_name_non_relative (source);
918 string d = make_port_name_non_relative (destination);
920 Port* src = get_port_by_name (s);
921 Port* dst = get_port_by_name (d);
924 ret = src->disconnect (d);
926 ret = dst->disconnect (s);
928 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
935 AudioEngine::disconnect (Port& port)
937 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
941 fatal << _("disconnect called before engine was started") << endmsg;
948 return port.disconnect_all ();
952 AudioEngine::frame_rate () const
954 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
955 if (_frame_rate == 0) {
956 return (_frame_rate = jack_get_sample_rate (_priv_jack));
963 AudioEngine::raw_buffer_size (DataType t)
965 std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
966 return (s != _raw_buffer_sizes.end()) ? s->second : 0;
970 AudioEngine::frames_per_cycle () const
972 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
973 if (_buffer_size == 0) {
974 return jack_get_buffer_size (_jack);
980 /** @param name Full or short name of port
981 * @return Corresponding Port*, or 0. This object remains the property of the AudioEngine
982 * so must not be deleted.
985 AudioEngine::get_port_by_name (const string& portname)
989 fatal << _("get_port_by_name() called before engine was started") << endmsg;
996 if (!port_is_mine (portname)) {
997 /* not an ardour port */
1001 std::string const rel = make_port_name_relative (portname);
1003 boost::shared_ptr<Ports> pr = ports.reader();
1005 for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1006 if (rel == (*i)->name()) {
1015 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1017 GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1020 fatal << _("get_ports called before engine was started") << endmsg;
1026 return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1030 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1032 /* called from jack shutdown handler */
1034 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1035 bool was_running = ae->_running;
1037 ae->stop_metering_thread ();
1039 ae->_running = false;
1040 ae->_buffer_size = 0;
1041 ae->_frame_rate = 0;
1045 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1047 case JackBackendError:
1048 ae->Halted(reason); /* EMIT SIGNAL */
1051 ae->Halted(""); /* EMIT SIGNAL */
1054 ae->Halted(""); /* EMIT SIGNAL */
1060 AudioEngine::halted (void *arg)
1062 cerr << "HALTED by JACK\n";
1064 /* called from jack shutdown handler */
1066 AudioEngine* ae = static_cast<AudioEngine *> (arg);
1067 bool was_running = ae->_running;
1069 ae->stop_metering_thread ();
1071 ae->_running = false;
1072 ae->_buffer_size = 0;
1073 ae->_frame_rate = 0;
1077 ae->Halted(""); /* EMIT SIGNAL */
1078 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1083 AudioEngine::died ()
1085 /* called from a signal handler for SIGPIPE */
1087 stop_metering_thread ();
1096 AudioEngine::can_request_hardware_monitoring ()
1098 GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1099 const char ** ports;
1101 if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1111 AudioEngine::n_physical (unsigned long flags) const
1115 GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1117 const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1122 for (uint32_t i = 0; ports[i]; ++i) {
1123 if (!strstr (ports[i], "Midi-Through")) {
1124 DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1125 c.set (t, c.get (t) + 1);
1135 AudioEngine::n_physical_inputs () const
1137 return n_physical (JackPortIsInput);
1141 AudioEngine::n_physical_outputs () const
1143 return n_physical (JackPortIsOutput);
1147 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1149 GET_PRIVATE_JACK_POINTER (_jack);
1150 const char ** ports;
1152 if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1157 for (uint32_t i = 0; ports[i]; ++i) {
1158 if (strstr (ports[i], "Midi-Through")) {
1161 phy.push_back (ports[i]);
1167 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1168 * a physical input connector.
1171 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1173 get_physical (type, JackPortIsOutput, ins);
1176 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1177 * a physical output connector.
1180 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1182 get_physical (type, JackPortIsInput, outs);
1186 AudioEngine::transport_stop ()
1188 GET_PRIVATE_JACK_POINTER (_jack);
1189 jack_transport_stop (_priv_jack);
1193 AudioEngine::transport_start ()
1195 GET_PRIVATE_JACK_POINTER (_jack);
1196 jack_transport_start (_priv_jack);
1200 AudioEngine::transport_locate (framepos_t where)
1202 GET_PRIVATE_JACK_POINTER (_jack);
1203 // cerr << "tell JACK to locate to " << where << endl;
1204 jack_transport_locate (_priv_jack, where);
1207 AudioEngine::TransportState
1208 AudioEngine::transport_state ()
1210 GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1211 jack_position_t pos;
1212 return (TransportState) jack_transport_query (_priv_jack, &pos);
1216 AudioEngine::reset_timebase ()
1218 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1220 if (_session->config.get_jack_time_master()) {
1221 return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1223 return jack_release_timebase (_jack);
1230 AudioEngine::freewheel (bool onoff)
1232 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1234 if (onoff != _freewheeling) {
1235 return jack_set_freewheel (_priv_jack, onoff);
1238 /* already doing what has been asked for */
1244 AudioEngine::remove_all_ports ()
1246 /* process lock MUST be held */
1249 RCUWriter<Ports> writer (ports);
1250 boost::shared_ptr<Ports> ps = writer.get_copy ();
1252 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1259 /* clear dead wood list too */
1265 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1267 EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
1268 boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
1269 jack_options_t options = JackNullOption;
1270 jack_status_t status;
1271 const char *server_name = NULL;
1273 /* revert all environment settings back to whatever they were when ardour started
1277 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
1278 global_epa->restore ();
1281 jack_client_name = client_name; /* might be reset below */
1282 #ifdef HAVE_JACK_SESSION
1283 if (! session_uuid.empty())
1284 _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1287 _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1289 if (_jack == NULL) {
1290 // error message is not useful here
1294 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1296 if (status & JackNameNotUnique) {
1297 jack_client_name = jack_get_client_name (_priv_jack);
1304 AudioEngine::disconnect_from_jack ()
1306 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1309 stop_metering_thread ();
1313 Glib::Mutex::Lock lm (_process_lock);
1314 jack_client_close (_priv_jack);
1320 _raw_buffer_sizes.clear();
1324 Stopped(); /* EMIT SIGNAL */
1325 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1332 AudioEngine::reconnect_to_jack ()
1335 disconnect_from_jack ();
1336 /* XXX give jackd a chance */
1337 Glib::usleep (250000);
1340 if (connect_to_jack (jack_client_name, "")) {
1341 error << _("failed to connect to JACK") << endmsg;
1347 boost::shared_ptr<Ports> p = ports.reader ();
1349 for (i = p->begin(); i != p->end(); ++i) {
1350 if ((*i)->reestablish ()) {
1355 if (i != p->end()) {
1357 remove_all_ports ();
1361 GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1363 MIDI::Manager::instance()->reestablish (_priv_jack);
1366 _session->reset_jack_connection (_priv_jack);
1367 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1368 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1371 last_monitor_check = 0;
1373 set_jack_callbacks ();
1375 if (jack_activate (_priv_jack) == 0) {
1382 /* re-establish connections */
1384 for (i = p->begin(); i != p->end(); ++i) {
1388 MIDI::Manager::instance()->reconnect ();
1390 Running (); /* EMIT SIGNAL*/
1392 start_metering_thread ();
1398 AudioEngine::request_buffer_size (pframes_t nframes)
1400 GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1402 if (nframes == jack_get_buffer_size (_priv_jack)) {
1406 return jack_set_buffer_size (_priv_jack, nframes);
1410 AudioEngine::update_total_latencies ()
1412 GET_PRIVATE_JACK_POINTER (_jack);
1413 jack_recompute_total_latencies (_priv_jack);
1417 AudioEngine::make_port_name_relative (string portname) const
1419 string::size_type len;
1420 string::size_type n;
1422 len = portname.length();
1424 for (n = 0; n < len; ++n) {
1425 if (portname[n] == ':') {
1430 if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1431 return portname.substr (n+1);
1438 AudioEngine::make_port_name_non_relative (string portname) const
1442 if (portname.find_first_of (':') != string::npos) {
1446 str = jack_client_name;
1454 AudioEngine::port_is_mine (const string& portname) const
1456 if (portname.find_first_of (':') != string::npos) {
1457 if (portname.substr (0, jack_client_name.length ()) != 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, pthread_t* thread, size_t stacksize)
1474 GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1475 ThreadData* td = new ThreadData (this, f, stacksize);
1477 if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack),
1478 jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1486 AudioEngine::_start_process_thread (void* arg)
1488 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1489 boost::function<void()> f = td->f;
1498 AudioEngine::port_is_physical (const std::string& portname) const
1500 GET_PRIVATE_JACK_POINTER_RET(_jack, false);
1502 jack_port_t *port = jack_port_by_name (_priv_jack, portname.c_str());
1508 return jack_port_flags (port) & JackPortIsPhysical;
1512 AudioEngine::ensure_monitor_input (const std::string& portname, bool yn) const
1514 GET_PRIVATE_JACK_POINTER(_jack);
1516 jack_port_t *port = jack_port_by_name (_priv_jack, portname.c_str());
1522 jack_port_request_monitor (port, yn);