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 <pthread.h>
  24
  25 #include <glibmm/threads.h>
  26
  27 #ifdef PLATFORM_WINDOWS
  28 #include "pbd/glib_semaphore.h"
  29 #endif
  30
  31 #include "pbd/crossthread.h"
  32 #include "pbd/ringbuffer.h"
  33 #include "pbd/pool.h"
  34 #include "ardour/libardour_visibility.h"
  35 #include "ardour/types.h"
  36 #include "ardour/session_handle.h"
  37
  38
  39
  40 namespace ARDOUR {
  41
  42 /**
  43  *  One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
  44  *  When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
  45  *  When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
  46  *  are empty they are deleted.
  47  */
  48
  49 class LIBARDOUR_API Butler : public SessionHandleRef
  50 {
  51   public:
  52         Butler (Session& session);
  53         ~Butler();
  54
  55         int  start_thread();
  56         void terminate_thread();
  57         void schedule_transport_work();
  58         void summon();
  59         void stop();
  60         void wait_until_finished();
  61         bool transport_work_requested() const;
  62         void drop_references ();
  63
  64         void map_parameters ();
  65
  66         framecnt_t audio_diskstream_capture_buffer_size() const { return audio_dstream_capture_buffer_size; }
  67         framecnt_t audio_diskstream_playback_buffer_size() const { return audio_dstream_playback_buffer_size; }
  68         uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
  69
  70         static void* _thread_work(void *arg);
  71         void*         thread_work();
  72
  73         struct Request {
  74                 enum Type {
  75                         Run,
  76                         Pause,
  77                         Quit
  78                 };
  79         };
  80
  81         pthread_t    thread;
  82         bool         have_thread;
  83         Glib::Threads::Mutex  request_lock;
  84         Glib::Threads::Cond   paused;
  85         bool         should_run;
  86         mutable gint should_do_transport_work;
  87         framecnt_t   audio_dstream_capture_buffer_size;
  88         framecnt_t   audio_dstream_playback_buffer_size;
  89         uint32_t     midi_dstream_buffer_size;
  90         RingBuffer<CrossThreadPool*> pool_trash;
  91
  92 private:
  93         void empty_pool_trash ();
  94         void config_changed (std::string);
  95
  96         /**
  97          * Add request to butler thread request queue
  98          */
  99         void queue_request (Request::Type r);
 100
 101         CrossThreadChannel _xthread;
 102
 103 };
 104
 105 } // namespace ARDOUR
 106
 107 #endif // __ardour_butler_h__