initial check in of VBAP implementation (not coupled to any existing ardour objects...
[ardour.git] / libs / ardour / audioengine.cc
index db1c4f2ef5e07e55107517e0c8062e9771ceafed..5f619d8392d26f02c83671870056ae0356fad6b6 100644 (file)
 #include <sstream>
 
 #include <glibmm/timer.h>
+#include <jack/jack.h>
+#include <jack/thread.h>
+
 #include "pbd/pthread_utils.h"
 #include "pbd/stacktrace.h"
 #include "pbd/unknown_type.h"
 
-#include "midi++/jack.h"
+#include "midi++/port.h"
+#include "midi++/mmc.h"
+#include "midi++/manager.h"
 
 #include "ardour/amp.h"
 #include "ardour/audio_port.h"
@@ -43,6 +48,7 @@
 #include "ardour/io.h"
 #include "ardour/meter.h"
 #include "ardour/midi_port.h"
+#include "ardour/process_thread.h"
 #include "ardour/port.h"
 #include "ardour/port_set.h"
 #include "ardour/session.h"
@@ -70,13 +76,14 @@ AudioEngine::AudioEngine (string client_name, string session_uuid)
        _running = false;
        _has_run = false;
        last_monitor_check = 0;
-       monitor_check_interval = max_frames;
+       monitor_check_interval = INT32_MAX;
        _processed_frames = 0;
        _usecs_per_cycle = 0;
        _jack = 0;
        _frame_rate = 0;
        _buffer_size = 0;
        _freewheeling = false;
+        _main_thread = 0;
 
        m_meter_thread = 0;
        g_atomic_int_set (&m_meter_exit, 0);
@@ -140,7 +147,20 @@ _thread_init_callback (void * /*arg*/)
 
        SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
 
-       MIDI::JACK_MidiPort::set_process_thread (pthread_self());
+       MIDI::Port::set_process_thread (pthread_self());
+}
+
+typedef void (*_JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);
+
+static void (*on_info_shutdown)(jack_client_t*, _JackInfoShutdownCallback, void *);
+extern void jack_on_info_shutdown (jack_client_t*, _JackInfoShutdownCallback, void *) __attribute__((weak));
+
+static void check_jack_symbols () __attribute__((constructor));
+
+void check_jack_symbols ()
+{
+       /* use weak linking to see if we really have various late-model JACK function */
+       on_info_shutdown = jack_on_info_shutdown;
 }
 
 static void
@@ -181,10 +201,15 @@ AudioEngine::start ()
                _processed_frames = 0;
                last_monitor_check = 0;
 
-               jack_on_shutdown (_priv_jack, halted, this);
+                if (on_info_shutdown) {
+                        jack_on_info_shutdown (_priv_jack, halted_info, this);
+                } else {
+                        jack_on_shutdown (_priv_jack, halted, this);
+                }
                jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
                jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
-               jack_set_process_callback (_priv_jack, _process_callback, this);
+               // jack_set_process_callback (_priv_jack, _process_callback, this);
+               jack_set_process_thread (_priv_jack, _process_thread, this);
                jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
                jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
                jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
@@ -212,6 +237,14 @@ AudioEngine::start ()
                }
 
                _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
+
+                jack_port_t* midi_port = jack_port_register (_priv_jack, "m", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
+                if (!midi_port) {
+                        error << _("Cannot create temporary MIDI port to determine MIDI buffer size") << endmsg;
+                } else {
+                        _raw_buffer_sizes[DataType::MIDI] = jack_midi_max_event_size (jack_port_get_buffer(midi_port, blocksize));
+                        jack_port_unregister (_priv_jack, midi_port);
+                }
        }
 
        return _running ? 0 : -1;
@@ -228,10 +261,14 @@ AudioEngine::stop (bool forever)
                } else {
                        jack_deactivate (_priv_jack);
                        Stopped(); /* EMIT SIGNAL */
-                       MIDI::JACK_MidiPort::JackHalted (); /* EMIT SIGNAL */
+                       MIDI::Port::JackHalted (); /* EMIT SIGNAL */
                }
        }
 
+        if (forever) {
+                stop_metering_thread ();
+        }
+
        return _running ? -1 : 0;
 }
 
@@ -336,6 +373,12 @@ AudioEngine::_process_callback (nframes_t nframes, void *arg)
        return static_cast<AudioEngine *> (arg)->process_callback (nframes);
 }
 
+void*
+AudioEngine::_process_thread (void *arg)
+{
+       return static_cast<AudioEngine *> (arg)->process_thread ();
+}
+
 void
 AudioEngine::_freewheel_callback (int onoff, void *arg)
 {
@@ -361,7 +404,7 @@ AudioEngine::split_cycle (nframes_t offset)
 {
        /* caller must hold process lock */
 
-       Port::increment_port_offset (offset);
+       AudioPort::increment_port_offset (offset);
 
        /* tell all Ports that we're going to start a new (split) cycle */
 
@@ -372,6 +415,38 @@ AudioEngine::split_cycle (nframes_t offset)
        }
 }
 
+void
+AudioEngine::finish_process_cycle (int /* status*/ )
+{
+        GET_PRIVATE_JACK_POINTER(_jack);
+        jack_cycle_signal (_jack, 0);
+}
+
+void*
+AudioEngine::process_thread ()
+{
+        /* JACK doesn't do this for us when we use the wait API 
+         */
+
+        _thread_init_callback (0);
+
+        _main_thread = new ProcessThread;
+
+        while (1) {
+                GET_PRIVATE_JACK_POINTER_RET(_jack,0);
+                jack_nframes_t nframes = jack_cycle_wait (_jack);
+
+                if (process_callback (nframes)) {
+                        cerr << "--- process\n";
+                        return 0;
+                }
+
+                finish_process_cycle (0);
+        }
+
+        return 0;
+}
+
 /** Method called by JACK (via _process_callback) which says that there
  * is work to be done.
  * @param nframes Number of frames to process.
@@ -379,7 +454,7 @@ AudioEngine::split_cycle (nframes_t offset)
 int
 AudioEngine::process_callback (nframes_t nframes)
 {
-       GET_PRIVATE_JACK_POINTER_RET(_jack,0)
+       GET_PRIVATE_JACK_POINTER_RET(_jack,0);
        // CycleTimer ct ("AudioEngine::process");
        Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
 
@@ -388,8 +463,8 @@ AudioEngine::process_callback (nframes_t nframes)
 
        /* handle wrap around of total frames counter */
 
-       if (max_frames - _processed_frames < nframes) {
-               next_processed_frames = nframes - (max_frames - _processed_frames);
+       if (max_framepos - _processed_frames < nframes) {
+               next_processed_frames = nframes - (max_framepos - _processed_frames);
        } else {
                next_processed_frames = _processed_frames + nframes;
        }
@@ -412,7 +487,7 @@ AudioEngine::process_callback (nframes_t nframes)
        /* tell all relevant objects that we're starting a new cycle */
 
        Delivery::CycleStart (nframes);
-       Port::set_port_offset (0);
+       AudioPort::set_port_offset (0);
        InternalReturn::CycleStart (nframes);
 
        /* tell all Ports that we're starting a new cycle */
@@ -423,17 +498,22 @@ AudioEngine::process_callback (nframes_t nframes)
                (*i)->cycle_start (nframes);
        }
 
-       if (_freewheeling) {
+       /* test if we are freewheeling and there are freewheel signals connected.
+           ardour should act normally even when freewheeling unless /it/ is exporting */
+
+
+       if (_freewheeling && !Freewheel.empty()) {
                /* emit the Freewheel signal and stop freewheeling in the event of trouble 
-                * the indirection is to pick up the return value of the signal.
                 */
-               if (*Freewheel (nframes)) {
+                boost::optional<int> r = Freewheel (nframes);
+               if (r.get_value_or (0)) {
                        jack_set_freewheel (_priv_jack, false);
                }
 
        } else {
                if (_session) {
                        _session->process (nframes);
+
                }
        }
 
@@ -525,16 +605,40 @@ AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
 int
 AudioEngine::jack_bufsize_callback (nframes_t nframes)
 {
+        bool need_midi_size = true;
+        bool need_audio_size = true;
+
        _buffer_size = nframes;
-       _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof(float);
-       cout << "FIXME: Assuming maximum MIDI buffer size " << nframes * 4 << "bytes" << endl;
-       _raw_buffer_sizes[DataType::MIDI] = nframes * 4;
        _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
        last_monitor_check = 0;
 
        boost::shared_ptr<Ports> p = ports.reader();
 
+        /* crude guesses, see below where we try to get the right answers.
+
+           Note that our guess for MIDI deliberatey tries to overestimate
+           by a little. It would be nicer if we could get the actual
+           size from a port, but we have to use this estimate in the 
+           event that there are no MIDI ports currently. If there are
+           the value will be adjusted below.
+         */
+
+        _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample);
+        _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2);
+
        for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
+
+                if (need_audio_size && (*i)->type() == DataType::AUDIO) {
+                        _raw_buffer_sizes[DataType::AUDIO] = (*i)->raw_buffer_size (nframes);
+                        need_audio_size = false;
+                }
+                
+                        
+                if (need_midi_size && (*i)->type() == DataType::MIDI) {
+                        _raw_buffer_sizes[DataType::MIDI] = (*i)->raw_buffer_size (nframes);
+                        need_midi_size = false;
+                }
+                
                (*i)->reset();
        }
 
@@ -927,9 +1031,41 @@ AudioEngine::get_ports (const string& port_name_pattern, const string& type_name
        return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
 }
 
+void
+AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg)
+{
+        /* called from jack shutdown handler  */
+        
+        AudioEngine* ae = static_cast<AudioEngine *> (arg);
+        bool was_running = ae->_running;
+        
+        ae->stop_metering_thread ();
+        
+        ae->_running = false;
+        ae->_buffer_size = 0;
+        ae->_frame_rate = 0;
+        ae->_jack = 0;
+        
+        if (was_running) {
+#ifdef HAVE_JACK_ON_INFO_SHUTDOWN
+                switch (code) {
+                case JackBackendError:
+                        ae->Halted(reason); /* EMIT SIGNAL */
+                        break;
+                default:
+                        ae->Halted(""); /* EMIT SIGNAL */
+                }
+#else
+                ae->Halted(""); /* EMIT SIGNAL */
+#endif
+        }
+}
+
 void
 AudioEngine::halted (void *arg)
 {
+        cerr << "HALTED by JACK\n";
+
         /* called from jack shutdown handler  */
 
        AudioEngine* ae = static_cast<AudioEngine *> (arg);
@@ -940,10 +1076,11 @@ AudioEngine::halted (void *arg)
        ae->_running = false;
        ae->_buffer_size = 0;
        ae->_frame_rate = 0;
+        ae->_jack = 0;
 
        if (was_running) {
-               ae->Halted(); /* EMIT SIGNAL */
-               MIDI::JACK_MidiPort::JackHalted (); /* EMIT SIGNAL */
+               ae->Halted(""); /* EMIT SIGNAL */
+               MIDI::Port::JackHalted (); /* EMIT SIGNAL */
        }
 }
 
@@ -975,99 +1112,79 @@ AudioEngine::can_request_hardware_monitoring ()
        return true;
 }
 
-
-uint32_t
-AudioEngine::n_physical_outputs (DataType type) const
+ChanCount
+AudioEngine::n_physical (unsigned long flags) const
 {
-       GET_PRIVATE_JACK_POINTER_RET (_jack,0);
-       const char ** ports;
-       uint32_t i = 0;
+       ChanCount c;
+       
+       GET_PRIVATE_JACK_POINTER_RET (_jack, c);
 
-       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical|JackPortIsInput)) == 0) {
-               return 0;
+       const char ** ports = jack_get_ports (_priv_jack, NULL, NULL, JackPortIsPhysical | flags);
+       if (ports == 0) {
+               return c;
+       }
+
+       for (uint32_t i = 0; ports[i]; ++i) {
+               if (!strstr (ports[i], "Midi-Through")) {
+                       DataType t (jack_port_type (jack_port_by_name (_jack, ports[i])));
+                       c.set (t, c.get (t) + 1);
+               }
        }
 
-       for (i = 0; ports[i]; ++i) {}
        free (ports);
 
-       return i;
+       return c;
 }
 
-uint32_t
-AudioEngine::n_physical_inputs (DataType type) const
+ChanCount
+AudioEngine::n_physical_inputs () const
 {
-       GET_PRIVATE_JACK_POINTER_RET (_jack,0);
-       const char ** ports;
-       uint32_t i = 0;
-
-       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical|JackPortIsOutput)) == 0) {
-               return 0;
-       }
-
-       for (i = 0; ports[i]; ++i) {}
-       free (ports);
+       return n_physical (JackPortIsInput);
+}
 
-       return i;
+ChanCount
+AudioEngine::n_physical_outputs () const
+{
+       return n_physical (JackPortIsOutput);
 }
 
 void
-AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
+AudioEngine::get_physical (DataType type, unsigned long flags, vector<string>& phy)
 {
        GET_PRIVATE_JACK_POINTER (_jack);
        const char ** ports;
 
-       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical|JackPortIsOutput)) == 0) {
+       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical | flags)) == 0) {
                return;
        }
 
        if (ports) {
                for (uint32_t i = 0; ports[i]; ++i) {
-                       ins.push_back (ports[i]);
+                        if (strstr (ports[i], "Midi-Through")) {
+                                continue;
+                        }
+                       phy.push_back (ports[i]);
                }
                free (ports);
        }
 }
 
+/** Get physical ports for which JackPortIsOutput is set; ie those that correspond to
+ *  a physical input connector.
+ */
 void
-AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
+AudioEngine::get_physical_inputs (DataType type, vector<string>& ins)
 {
-       GET_PRIVATE_JACK_POINTER (_jack);
-       const char ** ports;
-       uint32_t i = 0;
-
-       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical|JackPortIsInput)) == 0) {
-               return;
-       }
-
-       for (i = 0; ports[i]; ++i) {
-               outs.push_back (ports[i]);
-       }
-       free (ports);
+       get_physical (type, JackPortIsOutput, ins);
 }
 
-string
-AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
+/** Get physical ports for which JackPortIsInput is set; ie those that correspond to
+ *  a physical output connector.
+ */
+void
+AudioEngine::get_physical_outputs (DataType type, vector<string>& outs)
 {
-       GET_PRIVATE_JACK_POINTER_RET (_jack,"");
-       const char ** ports;
-       uint32_t i;
-       string ret;
-
-       assert(type != DataType::NIL);
-
-       if ((ports = jack_get_ports (_priv_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag)) == 0) {
-               return ret;
-       }
-
-       for (i = 0; i < n && ports[i]; ++i) {}
-
-       if (ports[i]) {
-               ret = ports[i];
-       }
-
-       free ((const char **) ports);
-
-       return ret;
+       get_physical (type, JackPortIsInput, outs);
 }
 
 void
@@ -1206,7 +1323,7 @@ AudioEngine::disconnect_from_jack ()
        if (_running) {
                _running = false;
                Stopped(); /* EMIT SIGNAL */
-               MIDI::JACK_MidiPort::JackHalted (); /* EMIT SIGNAL */
+               MIDI::Port::JackHalted (); /* EMIT SIGNAL */
        }
 
        return 0;
@@ -1244,15 +1361,12 @@ AudioEngine::reconnect_to_jack ()
 
        GET_PRIVATE_JACK_POINTER_RET (_jack,-1);
 
+       MIDI::Manager::instance()->reestablish (_priv_jack);
+       
        if (_session) {
                _session->reset_jack_connection (_priv_jack);
-               nframes_t blocksize = jack_get_buffer_size (_priv_jack);
-               _session->set_block_size (blocksize);
+                jack_bufsize_callback (jack_get_buffer_size (_priv_jack));
                _session->set_frame_rate (jack_get_sample_rate (_priv_jack));
-
-               _raw_buffer_sizes[DataType::AUDIO] = blocksize * sizeof(float);
-               cout << "FIXME: Assuming maximum MIDI buffer size " << blocksize * 4 << "bytes" << endl;
-               _raw_buffer_sizes[DataType::MIDI] = blocksize * 4;
        }
 
        last_monitor_check = 0;
@@ -1260,7 +1374,8 @@ AudioEngine::reconnect_to_jack ()
        jack_on_shutdown (_priv_jack, halted, this);
        jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this);
        jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this);
-       jack_set_process_callback (_priv_jack, _process_callback, this);
+       // jack_set_process_callback (_priv_jack, _process_callback, this);
+       jack_set_process_thread (_priv_jack, _process_thread, this);
        jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this);
        jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this);
        jack_set_xrun_callback (_priv_jack, _xrun_callback, this);
@@ -1288,6 +1403,8 @@ AudioEngine::reconnect_to_jack ()
                (*i)->reconnect ();
        }
 
+       MIDI::Manager::instance()->reconnect ();
+
        Running (); /* EMIT SIGNAL*/
 
        start_metering_thread ();
@@ -1359,3 +1476,29 @@ AudioEngine::is_realtime () const
        GET_PRIVATE_JACK_POINTER_RET (_jack,false);
        return jack_is_realtime (_priv_jack);
 }
+
+int
+AudioEngine::create_process_thread (boost::function<void()> f, pthread_t* thread, size_t stacksize)
+{
+        GET_PRIVATE_JACK_POINTER_RET (_jack, 0);
+        ThreadData* td = new ThreadData (this, f, stacksize);
+
+        if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack), 
+                                       jack_is_realtime (_priv_jack), _start_process_thread, td)) {
+                return -1;
+        } 
+
+        return 0;
+}
+
+void*
+AudioEngine::_start_process_thread (void* arg)
+{
+        ThreadData* td = reinterpret_cast<ThreadData*> (arg);
+        boost::function<void()> f = td->f;
+        delete td;
+
+        f ();
+
+        return 0;
+}