2 Copyright (C) 1999-2009 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.
24 #include "pbd/error.h"
25 #include "pbd/pthread_utils.h"
26 #include "ardour/butler.h"
27 #include "ardour/io.h"
28 #include "ardour/midi_diskstream.h"
29 #include "ardour/session.h"
30 #include "ardour/track.h"
31 #include "ardour/auditioner.h"
39 Butler::Butler(Session& s)
40 : SessionHandleRef (s)
42 , audio_dstream_capture_buffer_size(0)
43 , audio_dstream_playback_buffer_size(0)
44 , midi_dstream_buffer_size(0)
47 g_atomic_int_set(&should_do_transport_work, 0);
48 SessionEvent::pool->set_trash (&pool_trash);
50 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Butler::config_changed, this, _1));
59 Butler::config_changed (std::string p)
61 if (p == "playback-buffer-seconds") {
62 /* size is in Samples, not bytes */
63 audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * _session.frame_rate());
64 _session.adjust_playback_buffering ();
65 } else if (p == "capture-buffer-seconds") {
66 audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * _session.frame_rate());
67 _session.adjust_capture_buffering ();
72 Butler::start_thread()
74 const float rate = (float)_session.frame_rate();
76 /* size is in Samples, not bytes */
77 audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * rate);
78 audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * rate);
81 * XXX: Jack needs to tell us the MIDI buffer size
82 * (i.e. how many MIDI bytes we might see in a cycle)
84 midi_dstream_buffer_size = (uint32_t) floor (Config->get_midi_track_buffer_seconds() * rate);
86 MidiDiskstream::set_readahead_frames ((framecnt_t) (Config->get_midi_readahead() * rate));
90 if (pipe (request_pipe)) {
91 error << string_compose(_("Cannot create transport request signal pipe (%1)"),
92 strerror (errno)) << endmsg;
96 if (fcntl (request_pipe[0], F_SETFL, O_NONBLOCK)) {
97 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"),
98 strerror (errno)) << endmsg;
102 if (fcntl (request_pipe[1], F_SETFL, O_NONBLOCK)) {
103 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"),
104 strerror (errno)) << endmsg;
108 if (pthread_create_and_store ("disk butler", &thread, _thread_work, this)) {
109 error << _("Session: could not create butler thread") << endmsg;
113 //pthread_detach (thread);
119 Butler::terminate_thread ()
123 const char c = Request::Quit;
124 (void) ::write (request_pipe[1], &c, 1);
125 pthread_join (thread, &status);
130 Butler::_thread_work (void* arg)
132 SessionEvent::create_per_thread_pool ("butler events", 4096);
133 pthread_set_name (X_("butler"));
134 return ((Butler *) arg)->thread_work ();
138 Butler::thread_work ()
142 struct pollfd pfd[1];
143 bool disk_work_outstanding = false;
144 RouteList::iterator i;
147 pfd[0].fd = request_pipe[0];
148 pfd[0].events = POLLIN|POLLERR|POLLHUP;
150 if (poll (pfd, 1, (disk_work_outstanding ? 0 : -1)) < 0) {
152 if (errno == EINTR) {
156 error << string_compose (_("poll on butler request pipe failed (%1)"),
162 if (pfd[0].revents & ~POLLIN) {
163 error << string_compose (_("Error on butler thread request pipe: fd=%1 err=%2"), pfd[0].fd, pfd[0].revents) << endmsg;
167 if (pfd[0].revents & POLLIN) {
171 /* empty the pipe of all current requests */
174 size_t nread = ::read (request_pipe[0], &req, sizeof (req));
177 switch ((Request::Type) req) {
188 pthread_exit_pbd (0);
196 } else if (nread == 0) {
198 } else if (errno == EAGAIN) {
201 fatal << _("Error reading from butler request pipe") << endmsg;
209 disk_work_outstanding = false;
211 if (transport_work_requested()) {
212 _session.butler_transport_work ();
215 boost::shared_ptr<RouteList> rl = _session.get_routes();
217 RouteList rl_with_auditioner = *rl;
218 rl_with_auditioner.push_back (_session.the_auditioner());
220 // for (i = dsl->begin(); i != dsl->end(); ++i) {
221 // cerr << "BEFORE " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
224 for (i = rl_with_auditioner.begin(); !transport_work_requested() && should_run && i != rl_with_auditioner.end(); ++i) {
226 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
232 boost::shared_ptr<IO> io = tr->input ();
234 if (io && !io->active()) {
235 /* don't read inactive tracks */
239 switch (tr->do_refill ()) {
244 disk_work_outstanding = true;
248 error << string_compose(_("Butler read ahead failure on dstream %1"), (*i)->name()) << endmsg;
254 if (i != rl_with_auditioner.begin() && i != rl_with_auditioner.end()) {
255 /* we didn't get to all the streams */
256 disk_work_outstanding = true;
259 if (!err && transport_work_requested()) {
263 for (i = rl->begin(); !transport_work_requested() && should_run && i != rl->end(); ++i) {
264 // cerr << "write behind for " << (*i)->name () << endl;
266 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
272 /* note that we still try to flush diskstreams attached to inactive routes
275 switch (tr->do_flush (ButlerContext)) {
280 disk_work_outstanding = true;
285 error << string_compose(_("Butler write-behind failure on dstream %1"), (*i)->name()) << endmsg;
286 /* don't break - try to flush all streams in case they
287 are split across disks.
292 if (err && _session.actively_recording()) {
293 /* stop the transport and try to catch as much possible
294 captured state as we can.
296 _session.request_stop ();
299 if (i != rl->begin() && i != rl->end()) {
300 /* we didn't get to all the streams */
301 disk_work_outstanding = true;
304 if (!err && transport_work_requested()) {
308 if (!disk_work_outstanding) {
309 _session.refresh_disk_space ();
314 Glib::Threads::Mutex::Lock lm (request_lock);
316 if (should_run && (disk_work_outstanding || transport_work_requested())) {
317 // for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
318 // cerr << "AFTER " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
330 pthread_exit_pbd (0);
336 Butler::schedule_transport_work ()
338 g_atomic_int_inc (&should_do_transport_work);
345 char c = Request::Run;
346 (void) ::write (request_pipe[1], &c, 1);
352 Glib::Threads::Mutex::Lock lm (request_lock);
353 char c = Request::Pause;
354 (void) ::write (request_pipe[1], &c, 1);
355 paused.wait(request_lock);
359 Butler::wait_until_finished ()
361 Glib::Threads::Mutex::Lock lm (request_lock);
362 char c = Request::Pause;
363 (void) ::write (request_pipe[1], &c, 1);
364 paused.wait(request_lock);
368 Butler::transport_work_requested () const
370 return g_atomic_int_get(&should_do_transport_work);
374 Butler::empty_pool_trash ()
376 /* look in the trash, deleting empty pools until we come to one that is not empty */
378 RingBuffer<CrossThreadPool*>::rw_vector vec;
379 pool_trash.get_read_vector (&vec);
383 for (int i = 0; i < 2; ++i) {
384 for (guint j = 0; j < vec.len[i]; ++j) {
385 if (vec.buf[i][j]->empty()) {
386 delete vec.buf[i][j];
389 /* found a non-empty pool, so stop deleting */
391 pool_trash.increment_read_idx (deleted);
399 pool_trash.increment_read_idx (deleted);
404 Butler::drop_references ()
406 SessionEvent::pool->set_trash (0);
410 } // namespace ARDOUR