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