libs/ardour/ardour/graph.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3     Author: Torben Hohn
   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
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20
  21 #ifndef __ardour_graph_h__
  22 #define __ardour_graph_h__
  23
  24 #include <list>
  25 #include <set>
  26 #include <vector>
  27 #include <string>
  28
  29 #include <boost/shared_ptr.hpp>
  30
  31 #include <glib/gatomic.h>
  32 #include <cassert>
  33
  34 #include <pthread.h>
  35
  36 #include "pbd/semutils.h"
  37
  38 #include "ardour/types.h"
  39 #include "ardour/session_handle.h"
  40
  41 namespace ARDOUR
  42 {
  43
  44 class GraphNode;
  45 class Graph;
  46
  47 class Route;
  48 class Session;
  49
  50 typedef boost::shared_ptr<GraphNode> node_ptr_t;
  51 typedef boost::shared_ptr<Graph> graph_ptr_t;
  52
  53 typedef std::list< node_ptr_t > node_list_t;
  54 typedef std::set< node_ptr_t > node_set_t;
  55
  56 class Graph : public SessionHandleRef
  57 {
  58     public:
  59         Graph (Session & session);
  60
  61         void prep();
  62         void trigger (GraphNode * n);
  63         void rechain (boost::shared_ptr<RouteList> r);
  64
  65         void dump (int chain);
  66         void process();
  67         void dec_ref();
  68         void restart_cycle();
  69
  70         bool run_one();
  71         void helper_thread();
  72         void main_thread();
  73
  74         int silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  75                                    bool can_record, bool rec_monitors_input, bool& need_butler);
  76
  77         int process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
  78                             bool can_record, bool rec_monitors_input, bool& need_butler);
  79
  80         int routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  81                             bool non_rt_pending, bool can_record, int declick);
  82
  83         void process_one_route (Route * route);
  84
  85         void clear_other_chain ();
  86
  87         bool in_process_thread () const;
  88
  89     protected:
  90         virtual void session_going_away ();
  91
  92     private:
  93         std::list<pthread_t> _thread_list;
  94         volatile bool _quit_threads;
  95
  96         node_list_t _nodes_rt[2];
  97
  98         node_list_t _init_trigger_list[2];
  99
 100         std::vector<GraphNode *> _trigger_queue;
 101         pthread_mutex_t _trigger_mutex;
 102
 103         PBD::ProcessSemaphore _execution_sem;
 104
 105         PBD::ProcessSemaphore _callback_start_sem;
 106         PBD::ProcessSemaphore _callback_done_sem;
 107         PBD::ProcessSemaphore _cleanup_sem;
 108
 109         volatile gint _execution_tokens;
 110         volatile gint _finished_refcount;
 111         volatile gint _init_finished_refcount[2];
 112
 113         bool _graph_empty;
 114
 115         // chain swapping
 116         Glib::Mutex  _swap_mutex;
 117         Glib::Cond   _cleanup_cond;
 118         volatile int _current_chain;
 119         volatile int _pending_chain;
 120         volatile int _setup_chain;
 121
 122         // parameter caches.
 123         pframes_t       _process_nframes;
 124         framepos_t      _process_start_frame;
 125         framepos_t      _process_end_frame;
 126         bool            _process_can_record;
 127         bool            _process_rec_monitors_input;
 128         bool            _process_non_rt_pending;
 129         int             _process_declick;
 130
 131         bool            _process_silent;
 132         bool            _process_noroll;
 133         int             _process_retval;
 134         bool            _process_need_butler;
 135 };
 136
 137 } // namespace
 138
 139 #endif /* __ardour_graph_h__ */