Merge branch 'master' into cairocanvas
[ardour.git] / libs / ardour / butler.cc
index 05ac7316ec1af3f9b2a7e9e53e16ccc140a9bb59..c9eb55a472579b152f1bbb53fad5b3aae346991e 100644 (file)
 #include <errno.h>
 #include <fcntl.h>
 #include <unistd.h>
+
+#ifndef PLATFORM_WINDOWS
 #include <poll.h>
+#endif
+
 #include "pbd/error.h"
 #include "pbd/pthread_utils.h"
 #include "ardour/butler.h"
-#include "ardour/crossfade.h"
 #include "ardour/io.h"
 #include "ardour/midi_diskstream.h"
 #include "ardour/session.h"
+#include "ardour/track.h"
+#include "ardour/auditioner.h"
 
 #include "i18n.h"
 
 using namespace PBD;
 
-static float _read_data_rate;
-static float _write_data_rate;
-
 namespace ARDOUR {
 
-Butler::Butler(Session* s)
-       : session(s)
-       , thread(0)
-       , audio_dstream_buffer_size(0)
+Butler::Butler(Session& s)
+       : SessionHandleRef (s)
+       , thread()
+       , audio_dstream_capture_buffer_size(0)
+       , audio_dstream_playback_buffer_size(0)
        , midi_dstream_buffer_size(0)
+       , pool_trash(16)
 {
        g_atomic_int_set(&should_do_transport_work, 0);
+       SessionEvent::pool->set_trash (&pool_trash);
+
+        Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Butler::config_changed, this, _1));
 }
 
 Butler::~Butler()
 {
+       terminate_thread ();
 }
 
-int
-Butler::start_thread()
+void
+Butler::config_changed (std::string p)
 {
-       const float rate = (float)session->frame_rate();
-
-       /* size is in Samples, not bytes */
-       audio_dstream_buffer_size = (uint32_t) floor (Config->get_audio_track_buffer_seconds() * rate);
-
-       /* size is in bytes
-        * XXX: Jack needs to tell us the MIDI buffer size
-        * (i.e. how many MIDI bytes we might see in a cycle)
-        */
-       midi_dstream_buffer_size = (uint32_t) floor (Config->get_midi_track_buffer_seconds() * rate);
-
-       MidiDiskstream::set_readahead_frames ((nframes_t)(Config->get_midi_readahead() * rate));
-
-       Crossfade::set_buffer_size (audio_dstream_buffer_size);
-
-       should_run = false;
+        if (p == "playback-buffer-seconds") {
+                /* size is in Samples, not bytes */
+                audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * _session.frame_rate());
+                _session.adjust_playback_buffering ();
+        } else if (p == "capture-buffer-seconds") {
+                audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * _session.frame_rate());
+                _session.adjust_capture_buffering ();
+        }
+}
 
+#ifndef PLATFORM_WINDOWS
+int
+Butler::setup_request_pipe ()
+{
        if (pipe (request_pipe)) {
                error << string_compose(_("Cannot create transport request signal pipe (%1)"),
                                strerror (errno)) << endmsg;
@@ -88,6 +93,32 @@ Butler::start_thread()
                                strerror (errno)) << endmsg;
                return -1;
        }
+       return 0;
+}
+#endif
+
+int
+Butler::start_thread()
+{
+       const float rate = (float)_session.frame_rate();
+
+       /* size is in Samples, not bytes */
+       audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * rate);
+       audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * rate);
+
+       /* size is in bytes
+        * XXX: Jack needs to tell us the MIDI buffer size
+        * (i.e. how many MIDI bytes we might see in a cycle)
+        */
+       midi_dstream_buffer_size = (uint32_t) floor (Config->get_midi_track_buffer_seconds() * rate);
+
+       MidiDiskstream::set_readahead_frames ((framecnt_t) (Config->get_midi_readahead() * rate));
+
+       should_run = false;
+
+#ifndef PLATFORM_WINDOWS
+       if (setup_request_pipe() != 0) return -1;
+#endif
 
        if (pthread_create_and_store ("disk butler", &thread, _thread_work, this)) {
                error << _("Session: could not create butler thread") << endmsg;
@@ -102,46 +133,38 @@ Butler::start_thread()
 void
 Butler::terminate_thread ()
 {
-       if (thread) {
-               void* status;
-               const char c = Request::Quit;
-               ::write (request_pipe[1], &c, 1);
-               pthread_join (thread, &status);
-       }
+       void* status;
+       queue_request (Request::Quit);
+       pthread_join (thread, &status);
 }
 
 void *
 Butler::_thread_work (void* arg)
 {
-       SessionEvent::create_per_thread_pool ("butler events", 64);
+       SessionEvent::create_per_thread_pool ("butler events", 4096);
+       pthread_set_name (X_("butler"));
        return ((Butler *) arg)->thread_work ();
 }
 
-void *
-Butler::thread_work ()
+bool
+Butler::wait_for_requests ()
 {
-       uint32_t err = 0;
-       int32_t bytes;
-       bool compute_io;
-       microseconds_t begin, end;
-
+#ifndef PLATFORM_WINDOWS
        struct pollfd pfd[1];
-       bool disk_work_outstanding = false;
-       Session::DiskstreamList::iterator i;
 
-       while (true) {
-               pfd[0].fd = request_pipe[0];
-               pfd[0].events = POLLIN|POLLERR|POLLHUP;
+       pfd[0].fd = request_pipe[0];
+       pfd[0].events = POLLIN|POLLERR|POLLHUP;
 
-               if (poll (pfd, 1, (disk_work_outstanding ? 0 : -1)) < 0) {
+       while(true) {
+               if (poll (pfd, 1, -1) < 0) {
 
                        if (errno == EINTR) {
                                continue;
                        }
 
                        error << string_compose (_("poll on butler request pipe failed (%1)"),
-                                         strerror (errno))
-                             << endmsg;
+                                       strerror (errno))
+                               << endmsg;
                        break;
                }
 
@@ -151,19 +174,60 @@ Butler::thread_work ()
                }
 
                if (pfd[0].revents & POLLIN) {
+                       return true;
+               }
+       }
+       return false;
+#else
+       m_request_sem.wait ();
+       return true;
+#endif
+}
 
-                       char req;
-
-                       /* empty the pipe of all current requests */
+bool
+Butler::dequeue_request (Request::Type& r)
+{
+#ifndef PLATFORM_WINDOWS
+       char req;
+       size_t nread = ::read (request_pipe[0], &req, sizeof (req));
+       if (nread == 1) {
+               r = (Request::Type) req;
+               return true;
+       } else if (nread == 0) {
+               return false;
+       } else if (errno == EAGAIN) {
+               return false;
+       } else {
+               fatal << _("Error reading from butler request pipe") << endmsg;
+               /*NOTREACHED*/
+       }
+#else
+       r = (Request::Type) m_request_state.get();
+#endif
+       return false;
+}
 
-                       while (1) {
-                               size_t nread = ::read (request_pipe[0], &req, sizeof (req));
-                               if (nread == 1) {
+       void *
+Butler::thread_work ()
+{
+       uint32_t err = 0;
 
-                                       switch ((Request::Type) req) {
+       bool disk_work_outstanding = false;
+       RouteList::iterator i;
 
-                                       case Request::Wake:
-                                               break;
+       while (true) {
+               if(!disk_work_outstanding) {
+                       if (wait_for_requests ()) {
+                               Request::Type req;
+
+                               /* empty the pipe of all current requests */
+#ifdef PLATFORM_WINDOWS
+                               dequeue_request (req);
+                               {
+#else
+                               while(dequeue_request(req)) {
+#endif
+                                       switch (req) {
 
                                        case Request::Run:
                                                should_run = true;
@@ -174,110 +238,103 @@ Butler::thread_work ()
                                                break;
 
                                        case Request::Quit:
-                                               pthread_exit_pbd (0);
+                                               return 0;
                                                /*NOTREACHED*/
                                                break;
 
                                        default:
                                                break;
                                        }
-
-                               } else if (nread == 0) {
-                                       break;
-                               } else if (errno == EAGAIN) {
-                                       break;
-                               } else {
-                                       fatal << _("Error reading from butler request pipe") << endmsg;
-                                       /*NOTREACHED*/
                                }
                        }
                }
 
+
+restart:
+               disk_work_outstanding = false;
+
                if (transport_work_requested()) {
-                       session->butler_transport_work ();
+                       _session.butler_transport_work ();
                }
 
-               disk_work_outstanding = false;
-               bytes = 0;
-               compute_io = true;
+               frameoffset_t audition_seek;
+               if (should_run && _session.is_auditioning()
+                               && (audition_seek = _session.the_auditioner()->seek_frame()) >= 0) {
+                       boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (_session.the_auditioner());
+                       tr->seek(audition_seek);
+                       _session.the_auditioner()->seek_response(audition_seek);
+               }
 
-               begin = get_microseconds();
+               boost::shared_ptr<RouteList> rl = _session.get_routes();
 
-               boost::shared_ptr<Session::DiskstreamList> dsl = session->diskstream_list().reader ();
+               RouteList rl_with_auditioner = *rl;
+               rl_with_auditioner.push_back (_session.the_auditioner());
 
 //             for (i = dsl->begin(); i != dsl->end(); ++i) {
 //                     cerr << "BEFORE " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
 //             }
 
-               for (i = dsl->begin(); !transport_work_requested() && should_run && i != dsl->end(); ++i) {
+               for (i = rl_with_auditioner.begin(); !transport_work_requested() && should_run && i != rl_with_auditioner.end(); ++i) {
 
-                       boost::shared_ptr<Diskstream> ds = *i;
+                       boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 
-                       /* don't read inactive tracks */
+                       if (!tr) {
+                               continue;
+                       }
 
-                       boost::shared_ptr<IO> io = ds->io();
+                       boost::shared_ptr<IO> io = tr->input ();
 
                        if (io && !io->active()) {
+                               /* don't read inactive tracks */
                                continue;
                        }
 
-                       switch (ds->do_refill ()) {
+                       switch (tr->do_refill ()) {
                        case 0:
-                               bytes += ds->read_data_count();
                                break;
+                               
                        case 1:
-                               bytes += ds->read_data_count();
                                disk_work_outstanding = true;
                                break;
 
                        default:
-                               compute_io = false;
                                error << string_compose(_("Butler read ahead failure on dstream %1"), (*i)->name()) << endmsg;
                                break;
                        }
 
                }
 
-               if (i != dsl->end()) {
+               if (i != rl_with_auditioner.begin() && i != rl_with_auditioner.end()) {
                        /* we didn't get to all the streams */
                        disk_work_outstanding = true;
                }
 
                if (!err && transport_work_requested()) {
-                       continue;
+                       goto restart;
                }
 
-               if (compute_io) {
-                       end = get_microseconds();
-                       if (end - begin > 0) {
-                               _read_data_rate = (float) bytes / (float) (end - begin);
-                       } else {
-                               _read_data_rate = 0; // infinity better
-                       }
-               }
+               for (i = rl->begin(); !transport_work_requested() && should_run && i != rl->end(); ++i) {
+                       // cerr << "write behind for " << (*i)->name () << endl;
 
-               bytes = 0;
-               compute_io = true;
-               begin = get_microseconds();
+                       boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 
-               for (i = dsl->begin(); !transport_work_requested() && should_run && i != dsl->end(); ++i) {
-                       // cerr << "write behind for " << (*i)->name () << endl;
+                       if (!tr) {
+                               continue;
+                       }
 
                        /* note that we still try to flush diskstreams attached to inactive routes
                         */
 
-                       switch ((*i)->do_flush (ButlerContext)) {
+                       switch (tr->do_flush (ButlerContext)) {
                        case 0:
-                               bytes += (*i)->write_data_count();
                                break;
+                               
                        case 1:
-                               bytes += (*i)->write_data_count();
                                disk_work_outstanding = true;
                                break;
 
                        default:
                                err++;
-                               compute_io = false;
                                error << string_compose(_("Butler write-behind failure on dstream %1"), (*i)->name()) << endmsg;
                                /* don't break - try to flush all streams in case they
                                   are split across disks.
@@ -285,54 +342,44 @@ Butler::thread_work ()
                        }
                }
 
-               if (err && session->actively_recording()) {
+               if (err && _session.actively_recording()) {
                        /* stop the transport and try to catch as much possible
                           captured state as we can.
                        */
-                       session->request_stop ();
+                       _session.request_stop ();
                }
 
-               if (i != dsl->end()) {
+               if (i != rl->begin() && i != rl->end()) {
                        /* we didn't get to all the streams */
                        disk_work_outstanding = true;
                }
 
                if (!err && transport_work_requested()) {
-                       continue;
-               }
-
-               if (compute_io) {
-                       // there are no apparent users for this calculation?
-                       end = get_microseconds();
-                       if(end-begin > 0) {
-                       _write_data_rate = (float) bytes / (float) (end - begin);
-                       } else {
-                       _write_data_rate = 0; // Well, infinity would be better
-                       }
+                       goto restart;
                }
 
                if (!disk_work_outstanding) {
-                       session->refresh_disk_space ();
+                       _session.refresh_disk_space ();
                }
 
 
                {
-                       Glib::Mutex::Lock lm (request_lock);
+                       Glib::Threads::Mutex::Lock lm (request_lock);
 
                        if (should_run && (disk_work_outstanding || transport_work_requested())) {
 //                             for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
 //                                     cerr << "AFTER " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
 //                             }
 
-                               continue;
+                               goto restart;
                        }
 
                        paused.signal();
                }
+
+               empty_pool_trash ();
        }
 
-       pthread_exit_pbd (0);
-       /*NOTREACHED*/
        return (0);
 }
 
@@ -343,28 +390,37 @@ Butler::schedule_transport_work ()
        summon ();
 }
 
+void
+Butler::queue_request (Request::Type r)
+{
+#ifndef PLATFORM_WINDOWS
+       char c = r;
+       (void) ::write (request_pipe[1], &c, 1);
+#else
+       m_request_state.set (r);
+       m_request_sem.post ();
+#endif
+}
+
 void
 Butler::summon ()
 {
-       char c = Request::Run;
-       ::write (request_pipe[1], &c, 1);
+       queue_request (Request::Run);
 }
 
 void
 Butler::stop ()
 {
-       Glib::Mutex::Lock lm (request_lock);
-       char c = Request::Pause;
-       ::write (request_pipe[1], &c, 1);
+       Glib::Threads::Mutex::Lock lm (request_lock);
+       queue_request (Request::Pause);
        paused.wait(request_lock);
 }
 
 void
 Butler::wait_until_finished ()
 {
-       Glib::Mutex::Lock lm (request_lock);
-       char c = Request::Wake;
-       ::write (request_pipe[1], &c, 1);
+       Glib::Threads::Mutex::Lock lm (request_lock);
+       queue_request (Request::Pause);
        paused.wait(request_lock);
 }
 
@@ -374,22 +430,43 @@ Butler::transport_work_requested () const
        return g_atomic_int_get(&should_do_transport_work);
 }
 
-float
-Butler::read_data_rate () const
+void
+Butler::empty_pool_trash ()
 {
-       /* disk i/o in excess of 10000MB/sec indicate the buffer cache
-          in action. ignore it.
-       */
-       return _read_data_rate > 10485.7600000f ? 0.0f : _read_data_rate;
+       /* look in the trash, deleting empty pools until we come to one that is not empty */
+
+       RingBuffer<CrossThreadPool*>::rw_vector vec;
+       pool_trash.get_read_vector (&vec);
+
+       guint deleted = 0;
+
+       for (int i = 0; i < 2; ++i) {
+               for (guint j = 0; j < vec.len[i]; ++j) {
+                       if (vec.buf[i][j]->empty()) {
+                               delete vec.buf[i][j];
+                               ++deleted;
+                       } else {
+                               /* found a non-empty pool, so stop deleting */
+                               if (deleted) {
+                                       pool_trash.increment_read_idx (deleted);
+                               }
+                               return;
+                       }
+               }
+       }
+
+       if (deleted) {
+               pool_trash.increment_read_idx (deleted);
+       }
 }
 
-float
-Butler::write_data_rate () const
+void
+Butler::drop_references ()
 {
-       /* disk i/o in excess of 10000MB/sec indicate the buffer cache
-          in action. ignore it.
-       */
-       return _write_data_rate > 10485.7600000f ? 0.0f : _write_data_rate;
+       cerr << "Butler drops pool trash\n";
+       SessionEvent::pool->set_trash (0);
 }
 
+
 } // namespace ARDOUR
+