libs/ardour/ardour/butler.h

   1 /*
   2     Copyright (C) 2000-2009 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 #ifndef __ardour_butler_h__
  21 #define __ardour_butler_h__
  22
  23 #include <glibmm/thread.h>
  24
  25 #include "pbd/ringbuffer.h"
  26 #include "pbd/pool.h"
  27 #include "ardour/types.h"
  28 #include "ardour/session_handle.h"
  29
  30 namespace ARDOUR {
  31
  32 /**
  33  *  One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
  34  *  When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
  35  *  When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
  36  *  are empty they are deleted.
  37  */
  38
  39 class Butler : public SessionHandleRef
  40 {
  41   public:
  42         Butler (Session& session);
  43         ~Butler();
  44
  45         int  start_thread();
  46         void terminate_thread();
  47         void schedule_transport_work();
  48         void summon();
  49         void stop();
  50         void wait_until_finished();
  51         bool transport_work_requested() const;
  52
  53         float read_data_rate() const; ///< in usec
  54         float write_data_rate() const;
  55
  56         uint32_t audio_diskstream_buffer_size() const { return audio_dstream_buffer_size; }
  57         uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
  58
  59         static void* _thread_work(void *arg);
  60         void*         thread_work();
  61
  62         struct Request {
  63                 enum Type {
  64                         Wake,
  65                         Run,
  66                         Pause,
  67                         Quit
  68                 };
  69         };
  70
  71         pthread_t    thread;
  72         Glib::Mutex  request_lock;
  73         Glib::Cond   paused;
  74         bool         should_run;
  75         mutable gint should_do_transport_work;
  76         int          request_pipe[2];
  77         uint32_t     audio_dstream_buffer_size;
  78         uint32_t     midi_dstream_buffer_size;
  79         RingBuffer<CrossThreadPool*> pool_trash;
  80
  81 private:
  82         void empty_pool_trash ();
  83 };
  84
  85 } // namespace ARDOUR
  86
  87 #endif // __ardour_butler_h__