01b3c97c1690cc49e0281c3901fc634a0b3cb830
[ardour.git] / libs / surfaces / mackie / route_signal.h
1 /*
2         Copyright (C) 2006,2007 John Anderson
3
4         This program is free software; you can redistribute it and/or modify
5         it under the terms of the GNU General Public License as published by
6         the Free Software Foundation; either version 2 of the License, or
7         (at your option) any later version.
8
9         This program is distributed in the hope that it will be useful,
10         but WITHOUT ANY WARRANTY; without even the implied warranty of
11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12         GNU General Public License for more details.
13
14         You should have received a copy of the GNU General Public License
15         along with this program; if not, write to the Free Software
16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18 #ifndef route_signal_h
19 #define route_signal_h
20
21 #include <sigc++/sigc++.h>
22
23 #include <vector>
24
25 #include "midi_byte_array.h"
26
27 class MackieControlProtocol;
28
29 namespace ARDOUR {
30         class Route;
31 }
32         
33 namespace Mackie
34 {
35
36 class Strip;
37 class SurfacePort;
38
39 /**
40   This class is intended to easily create and destroy the set of
41   connections from a route to a control surface strip. Instantiating
42   it will connect the signals, and destructing it will disconnect
43   the signals.
44 */
45 class RouteSignal
46 {
47 public:
48         RouteSignal( ARDOUR::Route & route, MackieControlProtocol & mcp, Strip & strip, SurfacePort & port )
49         : _route( route ), _mcp( mcp ), _strip( strip ), _port( port ), _last_gain_written(0.0)
50         {
51                 connect();
52         }
53         
54         ~RouteSignal()
55         {
56                 disconnect();
57         }
58         
59         void connect();
60         void disconnect();
61         
62         // call all signal handlers manually
63         void notify_all();
64         
65         const ARDOUR::Route & route() const { return _route; }
66         Strip & strip() { return _strip; }
67         SurfacePort & port() { return _port; }
68         
69         float last_gain_written() const { return _last_gain_written; }
70         void last_gain_written( float other ) { _last_gain_written = other; }
71         
72         const MidiByteArray & last_pan_written() const { return _last_pan_written; }
73         void last_pan_written( const MidiByteArray & other ) { _last_pan_written = other; }
74         
75 private:
76         ARDOUR::Route & _route;
77         MackieControlProtocol & _mcp;
78         Strip & _strip;
79         SurfacePort & _port;
80
81         typedef std::vector<sigc::connection> Connections;
82         Connections _connections;
83
84         // Last written values for the gain and pan, to avoid overloading
85         // the midi connection to the surface
86         float _last_gain_written;
87         MidiByteArray _last_pan_written;
88 };
89
90 }
91
92 #endif