libs/ardour/ardour/process_thread.h

   1 /*
   2  * Copyright (C) 2010-2015 Paul Davis <paul@linuxaudiosystems.com>
   3  * Copyright (C) 2013-2017 Robin Gareus <robin@gareus.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef __libardour_process_thread__
  21 #define __libardour_process_thread__
  22
  23 #include <glibmm/threads.h>
  24
  25 #include "ardour/chan_count.h"
  26 #include "ardour/libardour_visibility.h"
  27 #include "ardour/types.h"
  28
  29 namespace ARDOUR {
  30
  31 class ThreadBuffers;
  32 class BufferSet;
  33
  34 class LIBARDOUR_API ProcessThread
  35 {
  36 public:
  37         ProcessThread ();
  38         ~ProcessThread ();
  39
  40         void init();
  41
  42         void get_buffers ();
  43         void drop_buffers ();
  44
  45         /* these MUST be called by a process thread's thread, nothing else */
  46
  47         static BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
  48         static BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = false);
  49         static BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
  50         static BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = false);
  51         static BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
  52         static gain_t* gain_automation_buffer ();
  53         static gain_t* trim_automation_buffer ();
  54         static gain_t* send_gain_automation_buffer ();
  55         static gain_t* scratch_automation_buffer ();
  56         static pan_t** pan_automation_buffer ();
  57
  58 protected:
  59         void session_going_away ();
  60
  61 private:
  62         static Glib::Threads::Private<ThreadBuffers> _private_thread_buffers;
  63 };
  64
  65 } // namespace
  66
  67 #endif /* __libardour_process_thread__ */