use JACK thread creation functions to create process-graph threads; provide GUI contr...
[ardour.git] / 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 #include <semaphore.h>
36
37 #include <ardour/types.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
49 typedef boost::shared_ptr<GraphNode> node_ptr_t;
50 typedef boost::shared_ptr<Graph> graph_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         void prep();
61         void trigger (GraphNode * n);
62         void rechain (boost::shared_ptr<RouteList> r);
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 (nframes_t nframes, framepos_t start_frame, framepos_t end_frame,
74                 bool can_record, bool rec_monitors_input, bool& need_butler);
75
76         int process_routes (nframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
77                 bool can_record, bool rec_monitors_input, bool& need_butler);
78
79         int routes_no_roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame, 
80                 bool non_rt_pending, bool can_record, int declick);
81
82         void process_one_route (Route * route);
83
84     protected:
85         virtual void session_going_away ();
86
87     private:
88         std::list<pthread_t> _thread_list;
89         volatile bool _quit_threads;
90         
91         node_list_t _nodes_rt[2];
92
93         node_list_t _init_trigger_list[2];
94
95         std::vector<GraphNode *> _trigger_queue;
96         pthread_mutex_t _trigger_mutex;
97
98
99         sem_t _execution_sem;
100
101         sem_t _callback_start_sem;
102         sem_t _callback_done_sem;
103
104         volatile gint _execution_tokens;
105         volatile gint _finished_refcount;
106         volatile gint _init_finished_refcount[2];
107
108         bool _graph_empty;
109
110         // chain swapping
111         pthread_mutex_t _swap_mutex;
112         volatile int _current_chain;
113         volatile int _pending_chain;
114         volatile int _setup_chain;
115
116         // parameter caches.
117         nframes_t       _process_nframes;
118         framepos_t      _process_start_frame;
119         framepos_t      _process_end_frame;
120         bool            _process_can_record;
121         bool            _process_rec_monitors_input;
122         bool            _process_non_rt_pending;
123         int             _process_declick;
124
125         bool            _process_silent;
126         bool            _process_noroll;
127         int             _process_retval;
128         bool            _process_need_butler;
129 };
130
131 } // namespace 
132
133 #endif /* __ardour_graph_h__ */