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
  33 #include "pbd/semutils.h"
  34
  35 #include "ardour/libardour_visibility.h"
  36 #include "ardour/types.h"
  37 #include "ardour/audio_backend.h"
  38 #include "ardour/session_handle.h"
  39
  40 namespace ARDOUR
  41 {
  42
  43 class GraphNode;
  44 class Graph;
  45
  46 class Route;
  47 class Session;
  48 class GraphEdges;
  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 LIBARDOUR_API Graph : public SessionHandleRef
  56 {
  57 public:
  58         Graph (Session & session);
  59
  60         void prep();
  61         void trigger (GraphNode * n);
  62         void rechain (boost::shared_ptr<RouteList>, GraphEdges const &);
  63
  64         void dump (int chain);
  65         void process();
  66         void dec_ref();
  67         void restart_cycle();
  68
  69         bool run_one();
  70         void helper_thread();
  71         void main_thread();
  72
  73         int silent_process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  74                                    bool& need_butler);
  75
  76         int process_routes (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
  77                             bool& need_butler);
  78
  79         int routes_no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  80                             bool non_rt_pending, int declick);
  81
  82         void process_one_route (Route * route);
  83
  84         void clear_other_chain ();
  85
  86         bool in_process_thread () const;
  87
  88 protected:
  89         virtual void session_going_away ();
  90
  91 private:
  92         volatile bool        _threads_active;
  93
  94         void reset_thread_list ();
  95         void drop_threads ();
  96
  97         node_list_t _nodes_rt[2];
  98
  99         node_list_t _init_trigger_list[2];
 100
 101         std::vector<GraphNode *> _trigger_queue;
 102         pthread_mutex_t          _trigger_mutex;
 103
 104         PBD::Semaphore _execution_sem;
 105
 106         /** Signalled to start a run of the graph for a process callback */
 107         PBD::Semaphore _callback_start_sem;
 108         PBD::Semaphore _callback_done_sem;
 109         PBD::Semaphore _cleanup_sem;
 110
 111         /** The number of processing threads that are asleep */
 112         volatile gint _execution_tokens;
 113         /** The number of unprocessed nodes that do not feed any other node; updated during processing */
 114         volatile gint _finished_refcount;
 115         /** The initial number of nodes that do not feed any other node (for each chain) */
 116         volatile gint _init_finished_refcount[2];
 117
 118         bool _graph_empty;
 119
 120         // chain swapping
 121         Glib::Threads::Mutex  _swap_mutex;
 122         Glib::Threads::Cond   _cleanup_cond;
 123         volatile int _current_chain;
 124         volatile int _pending_chain;
 125         volatile int _setup_chain;
 126
 127         // parameter caches.
 128         pframes_t  _process_nframes;
 129         framepos_t _process_start_frame;
 130         framepos_t _process_end_frame;
 131         bool       _process_can_record;
 132         bool       _process_non_rt_pending;
 133         int        _process_declick;
 134
 135         bool _process_silent;
 136         bool _process_noroll;
 137         int  _process_retval;
 138         bool _process_need_butler;
 139
 140         // enginer / thread connection
 141         PBD::ScopedConnectionList engine_connections;
 142         void engine_stopped ();
 143 };
 144
 145 } // namespace
 146
 147 #endif /* __ardour_graph_h__ */