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/crossfade.h"
28 #include "ardour/io.h"
29 #include "ardour/midi_diskstream.h"
30 #include "ardour/session.h"
31 #include "ardour/track.h"
32 #include "ardour/auditioner.h"
40 Butler::Butler(Session& s)
41 : SessionHandleRef (s)
43 , audio_dstream_capture_buffer_size(0)
44 , audio_dstream_playback_buffer_size(0)
45 , midi_dstream_buffer_size(0)
48 g_atomic_int_set(&should_do_transport_work, 0);
49 SessionEvent::pool->set_trash (&pool_trash);
51 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Butler::config_changed, this, _1));
60 Butler::config_changed (std::string p)
62 if (p == "playback-buffer-seconds") {
63 /* size is in Samples, not bytes */
64 audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * _session.frame_rate());
65 _session.adjust_playback_buffering ();
66 } else if (p == "capture-buffer-seconds") {
67 audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * _session.frame_rate());
68 _session.adjust_capture_buffering ();
73 Butler::start_thread()
75 const float rate = (float)_session.frame_rate();
77 /* size is in Samples, not bytes */
78 audio_dstream_capture_buffer_size = (uint32_t) floor (Config->get_audio_capture_buffer_seconds() * rate);
79 audio_dstream_playback_buffer_size = (uint32_t) floor (Config->get_audio_playback_buffer_seconds() * rate);
82 * XXX: Jack needs to tell us the MIDI buffer size
83 * (i.e. how many MIDI bytes we might see in a cycle)
85 midi_dstream_buffer_size = (uint32_t) floor (Config->get_midi_track_buffer_seconds() * rate);
87 MidiDiskstream::set_readahead_frames ((framecnt_t) (Config->get_midi_readahead() * rate));
89 Crossfade::set_buffer_size (audio_dstream_playback_buffer_size);
93 if (pipe (request_pipe)) {
94 error << string_compose(_("Cannot create transport request signal pipe (%1)"),
95 strerror (errno)) << endmsg;
99 if (fcntl (request_pipe[0], F_SETFL, O_NONBLOCK)) {
100 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"),
101 strerror (errno)) << endmsg;
105 if (fcntl (request_pipe[1], F_SETFL, O_NONBLOCK)) {
106 error << string_compose(_("UI: cannot set O_NONBLOCK on butler request pipe (%1)"),
107 strerror (errno)) << endmsg;
111 if (pthread_create_and_store ("disk butler", &thread, _thread_work, this)) {
112 error << _("Session: could not create butler thread") << endmsg;
116 //pthread_detach (thread);
122 Butler::terminate_thread ()
126 const char c = Request::Quit;
127 (void) ::write (request_pipe[1], &c, 1);
128 pthread_join (thread, &status);
133 Butler::_thread_work (void* arg)
135 SessionEvent::create_per_thread_pool ("butler events", 4096);
136 pthread_set_name (X_("butler"));
137 return ((Butler *) arg)->thread_work ();
141 Butler::thread_work ()
145 struct pollfd pfd[1];
146 bool disk_work_outstanding = false;
147 RouteList::iterator i;
150 pfd[0].fd = request_pipe[0];
151 pfd[0].events = POLLIN|POLLERR|POLLHUP;
153 if (poll (pfd, 1, (disk_work_outstanding ? 0 : -1)) < 0) {
155 if (errno == EINTR) {
159 error << string_compose (_("poll on butler request pipe failed (%1)"),
165 if (pfd[0].revents & ~POLLIN) {
166 error << string_compose (_("Error on butler thread request pipe: fd=%1 err=%2"), pfd[0].fd, pfd[0].revents) << endmsg;
170 if (pfd[0].revents & POLLIN) {
174 /* empty the pipe of all current requests */
177 size_t nread = ::read (request_pipe[0], &req, sizeof (req));
180 switch ((Request::Type) req) {
194 pthread_exit_pbd (0);
202 } else if (nread == 0) {
204 } else if (errno == EAGAIN) {
207 fatal << _("Error reading from butler request pipe") << endmsg;
215 disk_work_outstanding = false;
217 if (transport_work_requested()) {
218 _session.butler_transport_work ();
221 boost::shared_ptr<RouteList> rl = _session.get_routes();
223 RouteList rl_with_auditioner = *rl;
224 rl_with_auditioner.push_back (_session.the_auditioner());
226 // for (i = dsl->begin(); i != dsl->end(); ++i) {
227 // cerr << "BEFORE " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
230 for (i = rl_with_auditioner.begin(); !transport_work_requested() && should_run && i != rl_with_auditioner.end(); ++i) {
232 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
238 boost::shared_ptr<IO> io = tr->input ();
240 if (io && !io->active()) {
241 /* don't read inactive tracks */
245 switch (tr->do_refill ()) {
250 disk_work_outstanding = true;
254 error << string_compose(_("Butler read ahead failure on dstream %1"), (*i)->name()) << endmsg;
260 if (i != rl_with_auditioner.begin() && i != rl_with_auditioner.end()) {
261 /* we didn't get to all the streams */
262 disk_work_outstanding = true;
265 if (!err && transport_work_requested()) {
269 for (i = rl->begin(); !transport_work_requested() && should_run && i != rl->end(); ++i) {
270 // cerr << "write behind for " << (*i)->name () << endl;
272 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
278 /* note that we still try to flush diskstreams attached to inactive routes
281 switch (tr->do_flush (ButlerContext)) {
286 disk_work_outstanding = true;
291 error << string_compose(_("Butler write-behind failure on dstream %1"), (*i)->name()) << endmsg;
292 /* don't break - try to flush all streams in case they
293 are split across disks.
298 if (err && _session.actively_recording()) {
299 /* stop the transport and try to catch as much possible
300 captured state as we can.
302 _session.request_stop ();
305 if (i != rl->begin() && i != rl->end()) {
306 /* we didn't get to all the streams */
307 disk_work_outstanding = true;
310 if (!err && transport_work_requested()) {
314 if (!disk_work_outstanding) {
315 _session.refresh_disk_space ();
320 Glib::Mutex::Lock lm (request_lock);
322 if (should_run && (disk_work_outstanding || transport_work_requested())) {
323 // for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
324 // cerr << "AFTER " << (*i)->name() << ": pb = " << (*i)->playback_buffer_load() << " cp = " << (*i)->capture_buffer_load() << endl;
336 pthread_exit_pbd (0);
342 Butler::schedule_transport_work ()
344 g_atomic_int_inc (&should_do_transport_work);
351 char c = Request::Run;
352 (void) ::write (request_pipe[1], &c, 1);
358 Glib::Mutex::Lock lm (request_lock);
359 char c = Request::Pause;
360 (void) ::write (request_pipe[1], &c, 1);
361 paused.wait(request_lock);
365 Butler::wait_until_finished ()
367 Glib::Mutex::Lock lm (request_lock);
368 char c = Request::Wake;
369 (void) ::write (request_pipe[1], &c, 1);
370 paused.wait(request_lock);
374 Butler::transport_work_requested () const
376 return g_atomic_int_get(&should_do_transport_work);
380 Butler::empty_pool_trash ()
382 /* look in the trash, deleting empty pools until we come to one that is not empty */
384 RingBuffer<CrossThreadPool*>::rw_vector vec;
385 pool_trash.get_read_vector (&vec);
389 for (int i = 0; i < 2; ++i) {
390 for (guint j = 0; j < vec.len[i]; ++j) {
391 if (vec.buf[i][j]->empty()) {
392 delete vec.buf[i][j];
395 /* found a non-empty pool, so stop deleting */
397 pool_trash.increment_read_idx (deleted);
405 pool_trash.increment_read_idx (deleted);
410 Butler::drop_references ()
412 SessionEvent::pool->set_trash (0);
416 } // namespace ARDOUR