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
  52 typedef std::list< node_ptr_t > node_list_t;
  53 typedef std::set< node_ptr_t > node_set_t;
  54
  55 class Graph : public SessionHandleRef
  56 {
  57 public:
  58         Graph (Session & session);
  59
  60         uint32_t threads_in_use () const { return _thread_list.size(); }
  61
  62         void prep();
  63         void trigger (GraphNode * n);
  64         void rechain (boost::shared_ptr<RouteList> r);
  65
  66         void dump (int chain);
  67         void process();
  68         void dec_ref();
  69         void restart_cycle();
  70
  71         bool run_one();
  72         void helper_thread();
  73         void main_thread();
  74
  75         int silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  76                                    bool& need_butler);
  77
  78         int process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
  79                             bool& need_butler);
  80
  81         int routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  82                             bool non_rt_pending, int declick);
  83
  84         void process_one_route (Route * route);
  85
  86         void clear_other_chain ();
  87
  88         bool in_process_thread () const;
  89
  90 protected:
  91         virtual void session_going_away ();
  92
  93 private:
  94         std::list<pthread_t> _thread_list;
  95         volatile bool        _quit_threads;
  96         PBD::ScopedConnection processor_usage_connection;
  97
  98         void parameter_changed (std::string);
  99         void reset_thread_list ();
 100         void drop_threads ();
 101
 102         node_list_t _nodes_rt[2];
 103
 104         node_list_t _init_trigger_list[2];
 105
 106         std::vector<GraphNode *> _trigger_queue;
 107         pthread_mutex_t          _trigger_mutex;
 108
 109         PBD::ProcessSemaphore _execution_sem;
 110
 111         /** Signalled to start a run of the graph for a process callback */
 112         PBD::ProcessSemaphore _callback_start_sem;
 113         PBD::ProcessSemaphore _callback_done_sem;
 114         PBD::ProcessSemaphore _cleanup_sem;
 115
 116         /** The number of processing threads that are asleep */
 117         volatile gint _execution_tokens;
 118         /** The number of unprocessed nodes that do not feed any other node; updated during processing */
 119         volatile gint _finished_refcount;
 120         /** The initial number of nodes that do not feed any other node (for each chain) */
 121         volatile gint _init_finished_refcount[2];
 122
 123         bool _graph_empty;
 124
 125         // chain swapping
 126         Glib::Mutex  _swap_mutex;
 127         Glib::Cond   _cleanup_cond;
 128         volatile int _current_chain;
 129         volatile int _pending_chain;
 130         volatile int _setup_chain;
 131
 132         // parameter caches.
 133         pframes_t  _process_nframes;
 134         framepos_t _process_start_frame;
 135         framepos_t _process_end_frame;
 136         bool       _process_can_record;
 137         bool       _process_non_rt_pending;
 138         int        _process_declick;
 139
 140         bool _process_silent;
 141         bool _process_noroll;
 142         int  _process_retval;
 143         bool _process_need_butler;
 144 };
 145
 146 } // namespace
 147
 148 #endif /* __ardour_graph_h__ */