Stop saving of garbage values to LADSPA preset files when an output parameter is...
[ardour.git] / libs / ardour / audioengine.cc
1 /*
2     Copyright (C) 2002 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #include <unistd.h>
21 #include <cerrno>
22 #include <vector>
23 #include <exception>
24 #include <stdexcept>
25 #include <sstream>
26
27 #include <glibmm/timer.h>
28 #include <jack/jack.h>
29 #include <jack/thread.h>
30
31 #include "pbd/pthread_utils.h"
32 #include "pbd/stacktrace.h"
33 #include "pbd/unknown_type.h"
34 #include "pbd/epa.h"
35
36 #include "midi++/port.h"
37 #include "midi++/mmc.h"
38 #include "midi++/manager.h"
39
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"
58
59 #include "i18n.h"
60
61 using namespace std;
62 using namespace ARDOUR;
63 using namespace PBD;
64
65 gint AudioEngine::m_meter_exit;
66 AudioEngine* AudioEngine::_instance = 0;
67
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; }
70
71 AudioEngine::AudioEngine (string client_name, string session_uuid)
72         : ports (new Ports)
73 {
74         _instance = this; /* singleton */
75
76         session_remove_pending = false;
77         _running = false;
78         _has_run = false;
79         last_monitor_check = 0;
80         monitor_check_interval = INT32_MAX;
81         _processed_frames = 0;
82         _usecs_per_cycle = 0;
83         _jack = 0;
84         _frame_rate = 0;
85         _buffer_size = 0;
86         _freewheeling = false;
87         _main_thread = 0;
88
89         m_meter_thread = 0;
90         g_atomic_int_set (&m_meter_exit, 0);
91
92         if (connect_to_jack (client_name, session_uuid)) {
93                 throw NoBackendAvailable ();
94         }
95
96         Port::set_engine (this);
97
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(PanAzimuthAutomation);
103         p = EventTypeMap::instance().new_parameter(PanElevationAutomation);
104         p = EventTypeMap::instance().new_parameter(PanWidthAutomation);
105         p = EventTypeMap::instance().new_parameter(PluginAutomation);
106         p = EventTypeMap::instance().new_parameter(SoloAutomation);
107         p = EventTypeMap::instance().new_parameter(MuteAutomation);
108         p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
109         p = EventTypeMap::instance().new_parameter(MidiPgmChangeAutomation);
110         p = EventTypeMap::instance().new_parameter(MidiPitchBenderAutomation);
111         p = EventTypeMap::instance().new_parameter(MidiChannelPressureAutomation);
112         p = EventTypeMap::instance().new_parameter(FadeInAutomation);
113         p = EventTypeMap::instance().new_parameter(FadeOutAutomation);
114         p = EventTypeMap::instance().new_parameter(EnvelopeAutomation);
115         p = EventTypeMap::instance().new_parameter(MidiCCAutomation);
116 }
117
118 AudioEngine::~AudioEngine ()
119 {
120         {
121                 Glib::Mutex::Lock tm (_process_lock);
122                 session_removed.signal ();
123
124                 if (_running) {
125                         jack_client_close (_jack);
126                         _jack = 0;
127                 }
128
129                 stop_metering_thread ();
130         }
131 }
132
133 jack_client_t*
134 AudioEngine::jack() const
135 {
136         return _jack;
137 }
138
139 void
140 _thread_init_callback (void * /*arg*/)
141 {
142         /* make sure that anybody who needs to know about this thread
143            knows about it.
144         */
145
146         pthread_set_name (X_("audioengine"));
147
148         PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
149         PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
150
151         SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
152
153         MIDI::Port::set_process_thread (pthread_self());
154 }
155
156 typedef void (*_JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);
157
158 static void (*on_info_shutdown)(jack_client_t*, _JackInfoShutdownCallback, void *);
159 extern void jack_on_info_shutdown (jack_client_t*, _JackInfoShutdownCallback, void *) __attribute__((weak));
160
161 static void check_jack_symbols () __attribute__((constructor));
162
163 void check_jack_symbols ()
164 {
165        /* use weak linking to see if we really have various late-model JACK function */
166        on_info_shutdown = jack_on_info_shutdown;
167 }
168
169 static void
170 ardour_jack_error (const char* msg)
171 {
172         error << "JACK: " << msg << endmsg;
173 }
174
175 int
176 AudioEngine::start ()
177 {
178         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
179
180         if (!_running) {
181
182                 pframes_t blocksize = jack_get_buffer_size (_priv_jack);
183
184                 if (_session) {
185                         BootMessage (_("Connect session to engine"));
186
187                         _session->set_block_size (blocksize);
188                         _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
189
190                         /* page in as much of the session process code as we
191                            can before we really start running.
192                         */
193
194                         _session->process (blocksize);
195                         _session->process (blocksize);
196                         _session->process (blocksize);
197                         _session->process (blocksize);
198                         _session->process (blocksize);
199                         _session->process (blocksize);
200                         _session->process (blocksize);
201                         _session->process (blocksize);
202                 }
203
204                 _processed_frames = 0;
205                 last_monitor_check = 0;
206
207                 if (on_info_shutdown) {
208                         jack_on_info_shutdown (_priv_jack, halted_info, this);
209                 } else {
210                         jack_on_shutdown (_priv_jack, halted, this);
211                 }
212                 jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
213                 jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
214                 // jack_set_process_callback (_priv_jack, _process_callback, this);
215                 jack_set_process_thread (_priv_jack, _process_thread, this);
216                 jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
217                 jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
218                 jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
219 #ifdef HAVE_JACK_SESSION 
220                 if( jack_set_session_callback )
221                     jack_set_session_callback (_priv_jack, _session_callback, this);
222 #endif
223                 jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
224                 jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
225                 jack_set_port_registration_callback (_priv_jack, _registration_callback, this);
226                 jack_set_port_connect_callback (_priv_jack, _connect_callback, this);
227
228                 if (_session && _session->config.get_jack_time_master()) {
229                         jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
230                 }
231
232                 jack_set_error_function (ardour_jack_error);
233
234                 if (jack_activate (_priv_jack) == 0) {
235                         _running = true;
236                         _has_run = true;
237                         Running(); /* EMIT SIGNAL */
238                 } else {
239                         // error << _("cannot activate JACK client") << endmsg;
240                 }
241
242                 _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
243
244                 jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
245                 if (!midi_port) {
246                         error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
247                 } else {
248                         _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
249                         jack_port_unregister (_priv_jack, midi_port);
250                 }
251         }
252
253         return _running ? 0 : -1;
254 }
255
256 int
257 AudioEngine::stop (bool forever)
258 {
259         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
260
261         if (_priv_jack) {
262                 if (forever) {
263                         disconnect_from_jack ();
264                 } else {
265                         jack_deactivate (_priv_jack);
266                         Stopped(); /* EMIT SIGNAL */
267                         MIDI::Port::JackHalted (); /* EMIT SIGNAL */
268                 }
269         }
270
271         if (forever) {
272                 stop_metering_thread ();
273         }
274
275         return _running ? -1 : 0;
276 }
277
278
279 bool
280 AudioEngine::get_sync_offset (pframes_t& offset) const
281 {
282
283 #ifdef HAVE_JACK_VIDEO_SUPPORT
284
285         GET_PRIVATE_JACK_POINTER_RET (_jack, false);
286
287         jack_position_t pos;
288
289         if (_priv_jack) {
290                 (void) jack_transport_query (_priv_jack, &pos);
291
292                 if (pos.valid & JackVideoFrameOffset) {
293                         offset = pos.video_offset;
294                         return true;
295                 }
296         }
297 #else
298         /* keep gcc happy */
299         offset = 0;
300 #endif
301
302         return false;
303 }
304
305 void
306 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
307                                       jack_position_t* pos, int new_position, void *arg)
308 {
309         static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
310 }
311
312 void
313 AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes,
314                                      jack_position_t* pos, int new_position)
315 {
316         if (_jack && _session && _session->synced_to_jack()) {
317                 _session->jack_timebase_callback (state, nframes, pos, new_position);
318         }
319 }
320
321 int
322 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
323 {
324         return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
325 }
326
327 int
328 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
329 {
330         if (_jack && _session) {
331                 return _session->jack_sync_callback (state, pos);
332         }
333
334         return true;
335 }
336
337 int
338 AudioEngine::_xrun_callback (void *arg)
339 {
340         AudioEngine* ae = static_cast<AudioEngine*> (arg);
341         if (ae->connected()) {
342                 ae->Xrun (); /* EMIT SIGNAL */
343         }
344         return 0;
345 }
346
347 #ifdef HAVE_JACK_SESSION
348 void
349 AudioEngine::_session_callback (jack_session_event_t *event, void *arg)
350 {
351         printf( "helo.... " );
352         AudioEngine* ae = static_cast<AudioEngine*> (arg);
353         if (ae->connected()) {
354                 ae->JackSessionEvent ( event ); /* EMIT SIGNAL */
355         }
356 }
357 #endif
358 int
359 AudioEngine::_graph_order_callback (void *arg)
360 {
361         AudioEngine* ae = static_cast<AudioEngine*> (arg);
362         if (ae->connected()) {
363                 ae->GraphReordered (); /* EMIT SIGNAL */
364         }
365         return 0;
366 }
367
368 /** Wrapped which is called by JACK as its process callback.  It is just
369  * here to get us back into C++ land by calling AudioEngine::process_callback()
370  * @param nframes Number of frames passed by JACK.
371  * @param arg User argument passed by JACK, which will be the AudioEngine*.
372  */
373 int
374 AudioEngine::_process_callback (pframes_t nframes, void *arg)
375 {
376         return static_cast<AudioEngine *> (arg)->process_callback (nframes);
377 }
378
379 void*
380 AudioEngine::_process_thread (void *arg)
381 {
382         return static_cast<AudioEngine *> (arg)->process_thread ();
383 }
384
385 void
386 AudioEngine::_freewheel_callback (int onoff, void *arg)
387 {
388         static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
389 }
390
391 void
392 AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg)
393 {
394         AudioEngine* ae = static_cast<AudioEngine*> (arg);
395         ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
396 }
397
398 void
399 AudioEngine::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg)
400 {
401         AudioEngine* ae = static_cast<AudioEngine*> (arg);
402
403         GET_PRIVATE_JACK_POINTER (ae->_jack);
404
405         jack_port_t* jack_port_a = jack_port_by_id (_priv_jack, id_a);
406         jack_port_t* jack_port_b = jack_port_by_id (_priv_jack, id_b);
407
408         Port* port_a = 0;
409         Port* port_b = 0;
410
411         boost::shared_ptr<Ports> pr = ae->ports.reader ();
412         Ports::iterator i = pr->begin ();
413         while (i != pr->end() && (port_a == 0 || port_b == 0)) {
414                 if (jack_port_a == (*i)->_jack_port) {
415                         port_a = *i;
416                 } else if (jack_port_b == (*i)->_jack_port) {
417                         port_b = *i;
418                 }
419                 ++i;
420         }
421         
422         ae->PortConnectedOrDisconnected (port_a, port_b, conn == 0 ? false : true); /* EMIT SIGNAL */
423 }
424
425 void
426 AudioEngine::split_cycle (pframes_t offset)
427 {
428         /* caller must hold process lock */
429
430         AudioPort::increment_port_offset (offset);
431
432         /* tell all Ports that we're going to start a new (split) cycle */
433
434         boost::shared_ptr<Ports> p = ports.reader();
435
436         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
437                 (*i)->cycle_split ();
438         }
439 }
440
441 void
442 AudioEngine::finish_process_cycle (int /* status*/ )
443 {
444         GET_PRIVATE_JACK_POINTER(_jack);
445         jack_cycle_signal (_jack, 0);
446 }
447
448 void*
449 AudioEngine::process_thread ()
450 {
451         /* JACK doesn't do this for us when we use the wait API 
452          */
453
454         _thread_init_callback (0);
455
456         _main_thread = new ProcessThread;
457
458         while (1) {
459                 GET_PRIVATE_JACK_POINTER_RET(_jack,0);
460                 pframes_t nframes = jack_cycle_wait (_jack);
461
462                 if (process_callback (nframes)) {
463                         cerr << "--- process\n";
464                         return 0;
465                 }
466
467                 finish_process_cycle (0);
468         }
469
470         return 0;
471 }
472
473 /** Method called by JACK (via _process_callback) which says that there
474  * is work to be done.
475  * @param nframes Number of frames to process.
476  */
477 int
478 AudioEngine::process_callback (pframes_t nframes)
479 {
480         GET_PRIVATE_JACK_POINTER_RET(_jack,0);
481         // CycleTimer ct ("AudioEngine::process");
482         Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
483
484         /// The number of frames that will have been processed when we've finished
485         pframes_t next_processed_frames;
486
487         /* handle wrap around of total frames counter */
488
489         if (max_framepos - _processed_frames < nframes) {
490                 next_processed_frames = nframes - (max_framepos - _processed_frames);
491         } else {
492                 next_processed_frames = _processed_frames + nframes;
493         }
494
495         if (!tm.locked() || _session == 0) {
496                 /* return having done nothing */
497                 _processed_frames = next_processed_frames;
498                 return 0;
499         }
500
501         if (session_remove_pending) {
502                 /* perform the actual session removal */
503                 _session = 0;
504                 session_remove_pending = false;
505                 session_removed.signal();
506                 _processed_frames = next_processed_frames;
507                 return 0;
508         }
509
510         /* tell all relevant objects that we're starting a new cycle */
511
512         Delivery::CycleStart (nframes);
513         AudioPort::set_port_offset (0);
514         InternalReturn::CycleStart (nframes);
515
516         /* tell all Ports that we're starting a new cycle */
517
518         boost::shared_ptr<Ports> p = ports.reader();
519
520         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
521                 (*i)->cycle_start (nframes);
522         }
523
524         /* test if we are freewheeling and there are freewheel signals connected.
525            ardour should act normally even when freewheeling unless /it/ is exporting */
526
527
528         if (_freewheeling && !Freewheel.empty()) {
529                 /* emit the Freewheel signal and stop freewheeling in the event of trouble 
530                  */
531                 boost::optional<int> r = Freewheel (nframes);
532                 if (r.get_value_or (0)) {
533                         jack_set_freewheel (_priv_jack, false);
534                 }
535
536         } else {
537                 if (_session) {
538                         _session->process (nframes);
539
540                 }
541         }
542
543         if (_freewheeling) {
544                 return 0;
545         }
546
547         if (!_running) {
548                 _processed_frames = next_processed_frames;
549                 return 0;
550         }
551
552         if (last_monitor_check + monitor_check_interval < next_processed_frames) {
553
554                 boost::shared_ptr<Ports> p = ports.reader();
555
556                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
557
558                         Port *port = (*i);
559                         bool x;
560
561                         if (port->_last_monitor != (x = port->monitoring_input ())) {
562                                 port->_last_monitor = x;
563                                 /* XXX I think this is dangerous, due to
564                                    a likely mutex in the signal handlers ...
565                                 */
566                                  port->MonitorInputChanged (x); /* EMIT SIGNAL */
567                         }
568                 }
569                 last_monitor_check = next_processed_frames;
570         }
571
572         if (_session->silent()) {
573
574                 boost::shared_ptr<Ports> p = ports.reader();
575
576                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
577
578                         Port *port = (*i);
579
580                         if (port->sends_output()) {
581                                 port->get_buffer(nframes).silence(nframes);
582                         }
583                 }
584         }
585
586         // Finalize ports
587
588         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
589                 (*i)->cycle_end (nframes);
590         }
591
592         _processed_frames = next_processed_frames;
593         return 0;
594 }
595
596 int
597 AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg)
598 {
599         return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
600 }
601
602 int
603 AudioEngine::jack_sample_rate_callback (pframes_t nframes)
604 {
605         _frame_rate = nframes;
606         _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
607
608         /* check for monitor input change every 1/10th of second */
609
610         monitor_check_interval = nframes / 10;
611         last_monitor_check = 0;
612
613         if (_session) {
614                 _session->set_frame_rate (nframes);
615         }
616
617         SampleRateChanged (nframes); /* EMIT SIGNAL */
618
619         return 0;
620 }
621
622 int
623 AudioEngine::_bufsize_callback (pframes_t nframes, void *arg)
624 {
625         return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
626 }
627
628 int
629 AudioEngine::jack_bufsize_callback (pframes_t nframes)
630 {
631         bool need_midi_size = true;
632         bool need_audio_size = true;
633
634         _buffer_size = nframes;
635         _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
636         last_monitor_check = 0;
637
638         boost::shared_ptr<Ports> p = ports.reader();
639
640         /* crude guesses, see below where we try to get the right answers.
641
642            Note that our guess for MIDI deliberatey tries to overestimate
643            by a little. It would be nicer if we could get the actual
644            size from a port, but we have to use this estimate in the 
645            event that there are no MIDI ports currently. If there are
646            the value will be adjusted below.
647          */
648
649         _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
650         _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
651
652         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
653
654                 if (need_audio_size && (*i)->type() == DataType::AUDIO) {
655                         _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
656                         need_audio_size = false;
657                 }
658                 
659                         
660                 if (need_midi_size && (*i)->type() == DataType::MIDI) {
661                         _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
662                         need_midi_size = false;
663                 }
664                 
665                 (*i)->reset();
666         }
667
668         if (_session) {
669                 _session->set_block_size (_buffer_size);
670         }
671
672         return 0;
673 }
674
675 void
676 AudioEngine::stop_metering_thread ()
677 {
678         if (m_meter_thread) {
679                 g_atomic_int_set (&m_meter_exit, 1);
680                 m_meter_thread->join ();
681                 m_meter_thread = 0;
682         }
683 }
684
685 void
686 AudioEngine::start_metering_thread ()
687 {
688         if (m_meter_thread == 0) {
689                 g_atomic_int_set (&m_meter_exit, 0);
690                 m_meter_thread = Glib::Thread::create (boost::bind (&AudioEngine::meter_thread, this),
691                                                        500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
692         }
693 }
694
695 void
696 AudioEngine::meter_thread ()
697 {
698         pthread_set_name (X_("meter"));
699
700         while (true) {
701                 Glib::usleep (10000); /* 1/100th sec interval */
702                 if (g_atomic_int_get(&m_meter_exit)) {
703                         break;
704                 }
705                 Metering::Meter ();
706         }
707 }
708
709 void
710 AudioEngine::set_session (Session *s)
711 {
712         Glib::Mutex::Lock pl (_process_lock);
713
714         SessionHandlePtr::set_session (s);
715
716         if (_session) {
717
718                 start_metering_thread ();
719                 
720                 pframes_t blocksize = jack_get_buffer_size (_jack);
721                 
722                 /* page in as much of the session process code as we
723                    can before we really start running.
724                 */
725                 
726                 boost::shared_ptr<Ports> p = ports.reader();
727                 
728                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
729                         (*i)->cycle_start (blocksize);
730                 }
731                 
732                 _session->process (blocksize);
733                 _session->process (blocksize);
734                 _session->process (blocksize);
735                 _session->process (blocksize);
736                 _session->process (blocksize);
737                 _session->process (blocksize);
738                 _session->process (blocksize);
739                 _session->process (blocksize);
740                 
741                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
742                         (*i)->cycle_end (blocksize);
743                 }
744         }
745 }
746
747 void
748 AudioEngine::remove_session ()
749 {
750         Glib::Mutex::Lock lm (_process_lock);
751
752         if (_running) {
753
754                 stop_metering_thread ();
755
756                 if (_session) {
757                         session_remove_pending = true;
758                         session_removed.wait(_process_lock);
759                 }
760
761         } else {
762                 SessionHandlePtr::set_session (0);
763         }
764
765         remove_all_ports ();
766 }
767
768 void
769 AudioEngine::port_registration_failure (const std::string& portname)
770 {
771         GET_PRIVATE_JACK_POINTER (_jack);
772         string full_portname = jack_client_name;
773         full_portname += ':';
774         full_portname += portname;
775
776
777         jack_port_t* p = jack_port_by_name (_priv_jack, full_portname.c_str());
778         string reason;
779
780         if (p) {
781                 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
782         } else {
783                 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         }
785
786         throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
787 }
788
789 Port *
790 AudioEngine::register_port (DataType dtype, const string& portname, bool input)
791 {
792         Port* newport = 0;
793
794         try {
795                 if (dtype == DataType::AUDIO) {
796                         newport = new AudioPort (portname, (input ? Port::IsInput : Port::IsOutput));
797                 } else if (dtype == DataType::MIDI) {
798                         newport = new MidiPort (portname, (input ? Port::IsInput : Port::IsOutput));
799                 } else {
800                         throw PortRegistrationFailure("unable to create port (unknown type)");
801                 }
802
803                 size_t& old_buffer_size  = _raw_buffer_sizes[newport->type()];
804                 size_t  port_buffer_size = newport->raw_buffer_size(0);
805                 if (port_buffer_size > old_buffer_size) {
806                         old_buffer_size = port_buffer_size;
807                 }
808
809                 RCUWriter<Ports> writer (ports);
810                 boost::shared_ptr<Ports> ps = writer.get_copy ();
811                 ps->insert (ps->begin(), newport);
812
813                 /* writer goes out of scope, forces update */
814
815                 return newport;
816         }
817
818         catch (PortRegistrationFailure& err) {
819                 throw err;
820         } catch (std::exception& e) {
821                 throw PortRegistrationFailure(string_compose(
822                                 _("unable to create port: %1"), e.what()).c_str());
823         } catch (...) {
824                 throw PortRegistrationFailure("unable to create port (unknown error)");
825         }
826 }
827
828 Port *
829 AudioEngine::register_input_port (DataType type, const string& portname)
830 {
831         return register_port (type, portname, true);
832 }
833
834 Port *
835 AudioEngine::register_output_port (DataType type, const string& portname)
836 {
837         return register_port (type, portname, false);
838 }
839
840 int
841 AudioEngine::unregister_port (Port& port)
842 {
843         /* caller must hold process lock */
844
845         if (!_running) {
846                 /* probably happening when the engine has been halted by JACK,
847                    in which case, there is nothing we can do here.
848                    */
849                 return 0;
850         }
851
852         {
853                 RCUWriter<Ports> writer (ports);
854                 boost::shared_ptr<Ports> ps = writer.get_copy ();
855
856                 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
857                         if ((*i) == &port) {
858                                 delete *i;
859                                 ps->erase (i);
860                                 break;
861                         }
862                 }
863
864                 /* writer goes out of scope, forces update */
865         }
866
867         return 0;
868 }
869
870 int
871 AudioEngine::connect (const string& source, const string& destination)
872 {
873         int ret;
874
875         if (!_running) {
876                 if (!_has_run) {
877                         fatal << _("connect called before engine was started") << endmsg;
878                         /*NOTREACHED*/
879                 } else {
880                         return -1;
881                 }
882         }
883
884         string s = make_port_name_non_relative (source);
885         string d = make_port_name_non_relative (destination);
886
887
888         Port* src = get_port_by_name (s);
889         Port* dst = get_port_by_name (d);
890
891         if (src) {
892                 ret = src->connect (d);
893         } else if (dst) {
894                 ret = dst->connect (s);
895         } else {
896                 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
897                 ret = -1;
898         }
899
900         if (ret > 0) {
901                 /* already exists - no error, no warning */
902         } else if (ret < 0) {
903                 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
904                                         source, s, destination, d)
905                       << endmsg;
906         }
907
908         return ret;
909 }
910
911 int
912 AudioEngine::disconnect (const string& source, const string& destination)
913 {
914         int ret;
915
916         if (!_running) {
917                 if (!_has_run) {
918                         fatal << _("disconnect called before engine was started") << endmsg;
919                         /*NOTREACHED*/
920                 } else {
921                         return -1;
922                 }
923         }
924
925         string s = make_port_name_non_relative (source);
926         string d = make_port_name_non_relative (destination);
927
928         Port* src = get_port_by_name (s);
929         Port* dst = get_port_by_name (d);
930
931         if (src) {
932                         ret = src->disconnect (d);
933         } else if (dst) {
934                         ret = dst->disconnect (s);
935         } else {
936                 /* neither port is known to us, and this API isn't intended for use as a general patch bay */
937                 ret = -1;
938         }
939         return ret;
940 }
941
942 int
943 AudioEngine::disconnect (Port& port)
944 {
945         GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
946
947         if (!_running) {
948                 if (!_has_run) {
949                         fatal << _("disconnect called before engine was started") << endmsg;
950                         /*NOTREACHED*/
951                 } else {
952                         return -1;
953                 }
954         }
955
956         return port.disconnect_all ();
957 }
958
959 ARDOUR::framecnt_t
960 AudioEngine::frame_rate () const
961 {
962         GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
963         if (_frame_rate == 0) {
964                 return (_frame_rate = jack_get_sample_rate (_priv_jack));
965         } else {
966                 return _frame_rate;
967         }
968 }
969
970 size_t
971 AudioEngine::raw_buffer_size (DataType t)
972 {
973         std::map<DataType,size_t>::const_iterator s = _raw_buffer_sizes.find(t);
974         return (s != _raw_buffer_sizes.end()) ? s->second : 0;
975 }
976
977 ARDOUR::pframes_t
978 AudioEngine::frames_per_cycle () const
979 {
980         GET_PRIVATE_JACK_POINTER_RET (_jack,0);
981         if (_buffer_size == 0) {
982                 return (_buffer_size = jack_get_buffer_size (_jack));
983         } else {
984                 return _buffer_size;
985         }
986 }
987
988 /** @param name Full or short name of port
989  *  @return Corresponding Port*, or 0.  This object remains the property of the AudioEngine
990  *  so must not be deleted.
991  */
992 Port *
993 AudioEngine::get_port_by_name (const string& portname)
994 {
995         if (!_running) {
996                 if (!_has_run) {
997                         fatal << _("get_port_by_name() called before engine was started") << endmsg;
998                         /*NOTREACHED*/
999                 } else {
1000                         return 0;
1001                 }
1002         }
1003
1004         if (portname.find_first_of (':') != string::npos) {
1005                 if (portname.substr (0, jack_client_name.length ()) != jack_client_name) {
1006                         /* not an ardour: port */
1007                         return 0;
1008                 }
1009         }
1010
1011         std::string const rel = make_port_name_relative (portname);
1012
1013         boost::shared_ptr<Ports> pr = ports.reader();
1014
1015         for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
1016                 if (rel == (*i)->name()) {
1017                         return *i;
1018                 }
1019         }
1020
1021         return 0;
1022 }
1023
1024 const char **
1025 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
1026 {
1027         GET_PRIVATE_JACK_POINTER_RET (_jack,0);
1028         if (!_running) {
1029                 if (!_has_run) {
1030                         fatal << _("get_ports called before engine was started") << endmsg;
1031                         /*NOTREACHED*/
1032                 } else {
1033                         return 0;
1034                 }
1035         }
1036         return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
1037 }
1038
1039 void
1040 AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
1041 {
1042         /* called from jack shutdown handler  */
1043         
1044         AudioEngine* ae = static_cast<AudioEngine *> (arg);
1045         bool was_running = ae->_running;
1046         
1047         ae->stop_metering_thread ();
1048         
1049         ae->_running = false;
1050         ae->_buffer_size = 0;
1051         ae->_frame_rate = 0;
1052         ae->_jack = 0;
1053         
1054         if (was_running) {
1055 #ifdef HAVE_JACK_ON_INFO_SHUTDOWN
1056                 switch (code) {
1057                 case JackBackendError:
1058                         ae->Halted(reason); /* EMIT SIGNAL */
1059                         break;
1060                 default:
1061                         ae->Halted(""); /* EMIT SIGNAL */
1062                 }
1063 #else
1064                 ae->Halted(""); /* EMIT SIGNAL */
1065 #endif
1066         }
1067 }
1068
1069 void
1070 AudioEngine::halted (void *arg)
1071 {
1072         cerr << "HALTED by JACK\n";
1073
1074         /* called from jack shutdown handler  */
1075
1076         AudioEngine* ae = static_cast<AudioEngine *> (arg);
1077         bool was_running = ae->_running;
1078
1079         ae->stop_metering_thread ();
1080
1081         ae->_running = false;
1082         ae->_buffer_size = 0;
1083         ae->_frame_rate = 0;
1084         ae->_jack = 0;
1085
1086         if (was_running) {
1087                 ae->Halted(""); /* EMIT SIGNAL */
1088                 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1089         }
1090 }
1091
1092 void
1093 AudioEngine::died ()
1094 {
1095         /* called from a signal handler for SIGPIPE */
1096
1097         stop_metering_thread ();
1098
1099         _running = false;
1100         _buffer_size = 0;
1101         _frame_rate = 0;
1102         _jack = 0;
1103 }
1104
1105 bool
1106 AudioEngine::can_request_hardware_monitoring ()
1107 {
1108         GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1109         const char ** ports;
1110
1111         if ((ports = jack_get_ports (_priv_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
1112                 return false;
1113         }
1114
1115         free (ports);
1116
1117         return true;
1118 }
1119
1120 ChanCount
1121 AudioEngine::n_physical (unsigned long flags) const
1122 {
1123         ChanCount c;
1124         
1125         GET_PRIVATE_JACK_POINTER_RET (_jack, c);
1126
1127         const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
1128         if (ports == 0) {
1129                 return c;
1130         }
1131
1132         for (uint32_t i = 0; ports[i]; ++i) {
1133                 if (!strstr (ports[i], "Midi-Through")) {
1134                         DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
1135                         c.set (t, c.get (t) + 1);
1136                 }
1137         }
1138
1139         free (ports);
1140
1141         return c;
1142 }
1143
1144 ChanCount
1145 AudioEngine::n_physical_inputs () const
1146 {
1147         return n_physical (JackPortIsInput);
1148 }
1149
1150 ChanCount
1151 AudioEngine::n_physical_outputs () const
1152 {
1153         return n_physical (JackPortIsOutput);
1154 }
1155
1156 void
1157 AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
1158 {
1159         GET_PRIVATE_JACK_POINTER (_jack);
1160         const char ** ports;
1161
1162         if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
1163                 return;
1164         }
1165
1166         if (ports) {
1167                 for (uint32_t i = 0; ports[i]; ++i) {
1168                         if (strstr (ports[i], "Midi-Through")) {
1169                                 continue;
1170                         }
1171                         phy.push_back (ports[i]);
1172                 }
1173                 free (ports);
1174         }
1175 }
1176
1177 /** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
1178  *  a physical input connector.
1179  */
1180 void
1181 AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
1182 {
1183         get_physical (type, JackPortIsOutput, ins);
1184 }
1185
1186 /** Get physical ports for which JackPortIsInput is set; ie those that correspond to
1187  *  a physical output connector.
1188  */
1189 void
1190 AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
1191 {
1192         get_physical (type, JackPortIsInput, outs);
1193 }
1194
1195 void
1196 AudioEngine::update_total_latency (const Port& port)
1197 {
1198         port.recompute_total_latency ();
1199 }
1200
1201 void
1202 AudioEngine::transport_stop ()
1203 {
1204         GET_PRIVATE_JACK_POINTER (_jack);
1205         jack_transport_stop (_priv_jack);
1206 }
1207
1208 void
1209 AudioEngine::transport_start ()
1210 {
1211         GET_PRIVATE_JACK_POINTER (_jack);
1212         jack_transport_start (_priv_jack);
1213 }
1214
1215 void
1216 AudioEngine::transport_locate (framepos_t where)
1217 {
1218         GET_PRIVATE_JACK_POINTER (_jack);
1219         // cerr << "tell JACK to locate to " << where << endl;
1220         jack_transport_locate (_priv_jack, where);
1221 }
1222
1223 AudioEngine::TransportState
1224 AudioEngine::transport_state ()
1225 {
1226         GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped));
1227         jack_position_t pos;
1228         return (TransportState) jack_transport_query (_priv_jack, &pos);
1229 }
1230
1231 int
1232 AudioEngine::reset_timebase ()
1233 {
1234         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1235         if (_session) {
1236                 if (_session->config.get_jack_time_master()) {
1237                         return jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1238                 } else {
1239                         return jack_release_timebase (_jack);
1240                 }
1241         }
1242         return 0;
1243 }
1244
1245 int
1246 AudioEngine::freewheel (bool onoff)
1247 {
1248         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1249
1250         if (onoff != _freewheeling) {
1251                 return jack_set_freewheel (_priv_jack, onoff);
1252                 
1253         } else {
1254                 /* already doing what has been asked for */
1255                 return 0;
1256         }
1257 }
1258
1259 void
1260 AudioEngine::remove_all_ports ()
1261 {
1262         /* process lock MUST be held */
1263
1264         {
1265                 RCUWriter<Ports> writer (ports);
1266                 boost::shared_ptr<Ports> ps = writer.get_copy ();
1267
1268                 for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
1269                         delete *i;
1270                 }
1271
1272                 ps->clear ();
1273         }
1274
1275         /* clear dead wood list too */
1276
1277         ports.flush ();
1278 }
1279
1280 int
1281 AudioEngine::connect_to_jack (string client_name, string session_uuid)
1282 {
1283         EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa ();
1284         boost::scoped_ptr<EnvironmentalProtectionAgency> current_epa;
1285         jack_options_t options = JackNullOption;
1286         jack_status_t status;
1287         const char *server_name = NULL;
1288
1289         /* revert all environment settings back to whatever they were when ardour started
1290          */
1291
1292         if (global_epa) {
1293                 current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */
1294                 global_epa->restore ();
1295         }
1296
1297         jack_client_name = client_name; /* might be reset below */
1298 #ifdef HAVE_JACK_SESSION
1299         if (! session_uuid.empty())
1300             _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str());
1301         else
1302 #endif
1303             _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1304
1305         if (_jack == NULL) {
1306                 // error message is not useful here
1307                 return -1;
1308         }
1309
1310         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1311
1312         if (status & JackNameNotUnique) {
1313                 jack_client_name = jack_get_client_name (_priv_jack);
1314         }
1315
1316         return 0;
1317 }
1318
1319 int
1320 AudioEngine::disconnect_from_jack ()
1321 {
1322         GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1323
1324         if (_running) {
1325                 stop_metering_thread ();
1326         }
1327
1328         {
1329                 Glib::Mutex::Lock lm (_process_lock);
1330                 jack_client_close (_priv_jack);
1331                 _jack = 0;
1332         }
1333
1334         _buffer_size = 0;
1335         _frame_rate = 0;
1336         _raw_buffer_sizes.clear();
1337
1338         if (_running) {
1339                 _running = false;
1340                 Stopped(); /* EMIT SIGNAL */
1341                 MIDI::Port::JackHalted (); /* EMIT SIGNAL */
1342         }
1343
1344         return 0;
1345 }
1346
1347 int
1348 AudioEngine::reconnect_to_jack ()
1349 {
1350         if (_running) {
1351                 disconnect_from_jack ();
1352                 /* XXX give jackd a chance */
1353                 Glib::usleep (250000);
1354         }
1355
1356         if (connect_to_jack (jack_client_name, "")) {
1357                 error << _("failed to connect to JACK") << endmsg;
1358                 return -1;
1359         }
1360
1361         Ports::iterator i;
1362
1363         boost::shared_ptr<Ports> p = ports.reader ();
1364
1365         for (i = p->begin(); i != p->end(); ++i) {
1366                 if ((*i)->reestablish ()) {
1367                         break;
1368                 }
1369         }
1370
1371         if (i != p->end()) {
1372                 /* failed */
1373                 remove_all_ports ();
1374                 return -1;
1375         }
1376
1377         GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
1378
1379         MIDI::Manager::instance()->reestablish (_priv_jack);
1380         
1381         if (_session) {
1382                 _session->reset_jack_connection (_priv_jack);
1383                 jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
1384                 _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
1385         }
1386
1387         last_monitor_check = 0;
1388
1389         jack_on_shutdown (_priv_jack, halted, this);
1390         jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
1391         jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
1392         // jack_set_process_callback (_priv_jack, _process_callback, this);
1393         jack_set_process_thread (_priv_jack, _process_thread, this);
1394         jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
1395         jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
1396         jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
1397 #ifdef HAVE_JACK_SESSION
1398         if( jack_set_session_callback )
1399             jack_set_session_callback (_priv_jack, _session_callback, this);
1400 #endif
1401         jack_set_sync_callback (_priv_jack, _jack_sync_callback, this);
1402         jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this);
1403
1404         if (_session && _session->config.get_jack_time_master()) {
1405                 jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this);
1406         }
1407
1408         if (jack_activate (_priv_jack) == 0) {
1409                 _running = true;
1410                 _has_run = true;
1411         } else {
1412                 return -1;
1413         }
1414
1415         /* re-establish connections */
1416
1417         for (i = p->begin(); i != p->end(); ++i) {
1418                 (*i)->reconnect ();
1419         }
1420
1421         MIDI::Manager::instance()->reconnect ();
1422
1423         Running (); /* EMIT SIGNAL*/
1424
1425         start_metering_thread ();
1426
1427         return 0;
1428 }
1429
1430 int
1431 AudioEngine::request_buffer_size (pframes_t nframes)
1432 {
1433         GET_PRIVATE_JACK_POINTER_RET (_jack, -1);
1434
1435         if (nframes == jack_get_buffer_size (_priv_jack)) {
1436           return 0;
1437         }
1438         
1439         return jack_set_buffer_size (_priv_jack, nframes);
1440 }
1441
1442 void
1443 AudioEngine::update_total_latencies ()
1444 {
1445 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1446         GET_PRIVATE_JACK_POINTER (_jack);
1447         jack_recompute_total_latencies (_priv_jack);
1448 #endif
1449 }
1450
1451 string
1452 AudioEngine::make_port_name_relative (string portname)
1453 {
1454         string::size_type len;
1455         string::size_type n;
1456
1457         len = portname.length();
1458
1459         for (n = 0; n < len; ++n) {
1460                 if (portname[n] == ':') {
1461                         break;
1462                 }
1463         }
1464
1465         if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1466                 return portname.substr (n+1);
1467         }
1468
1469         return portname;
1470 }
1471
1472 string
1473 AudioEngine::make_port_name_non_relative (string portname)
1474 {
1475         string str;
1476
1477         if (portname.find_first_of (':') != string::npos) {
1478                 return portname;
1479         }
1480
1481         str  = jack_client_name;
1482         str += ':';
1483         str += portname;
1484
1485         return str;
1486 }
1487
1488 bool
1489 AudioEngine::is_realtime () const
1490 {
1491         GET_PRIVATE_JACK_POINTER_RET (_jack,false);
1492         return jack_is_realtime (_priv_jack);
1493 }
1494
1495 int
1496 AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
1497 {
1498         GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
1499         ThreadData* td = new ThreadData (this, f, stacksize);
1500
1501         if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack), 
1502                                        jack_is_realtime (_priv_jack), _start_process_thread, td)) {
1503                 return -1;
1504         } 
1505
1506         return 0;
1507 }
1508
1509 void*
1510 AudioEngine::_start_process_thread (void* arg)
1511 {
1512         ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1513         boost::function<void()> f = td->f;
1514         delete td;
1515
1516         f ();
1517
1518         return 0;
1519 }