merge from 2.0-ongoing @ 3581
[ardour.git] / gtk2_ardour / region_view.h
1 /*
2     Copyright (C) 2001-2006 Paul Davis 
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
19 #ifndef __gtk_ardour_region_view_h__
20 #define __gtk_ardour_region_view_h__
21
22 #include <vector>
23
24 #include <libgnomecanvasmm.h>
25 #include <libgnomecanvasmm/polygon.h>
26 #include <sigc++/signal.h>
27 #include <ardour/region.h>
28
29 #include "time_axis_view_item.h"
30 #include "automation_line.h"
31 #include "enums.h"
32 #include "waveview.h"
33 #include "canvas.h"
34
35 class TimeAxisView;
36 class RegionEditor;
37 class GhostRegion;
38 class AutomationTimeAxisView;
39 class AutomationRegionView;
40
41 class RegionView : public TimeAxisViewItem
42 {
43   public:
44         RegionView (ArdourCanvas::Group* parent, 
45                     TimeAxisView&        time_view,
46                     boost::shared_ptr<ARDOUR::Region> region,
47                     double               samples_per_unit,
48                     Gdk::Color&          basic_color);
49
50         RegionView (const RegionView& other);
51         RegionView (const RegionView& other, boost::shared_ptr<ARDOUR::Region> other_region);
52
53         ~RegionView ();
54         
55         virtual void init (Gdk::Color& base_color, bool wait_for_data);
56     
57         boost::shared_ptr<ARDOUR::Region> region() const { return _region; }
58         
59         bool is_valid() const    { return valid; }
60
61
62         void set_valid (bool yn) { valid = yn; }
63         
64         virtual void set_height (double);
65         virtual void set_samples_per_unit (double);
66         virtual bool set_duration (nframes_t, void*);
67         
68         void move (double xdelta, double ydelta);
69         
70         void raise_to_top ();
71         void lower_to_bottom ();
72
73         bool set_position(nframes_t pos, void* src, double* delta = 0);
74         void fake_set_opaque (bool yn);
75         
76         virtual void show_region_editor () {}
77         virtual void hide_region_editor();
78         
79         virtual void region_changed (ARDOUR::Change);
80         
81         virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
82         void remove_ghost_in (TimeAxisView&);
83         void remove_ghost (GhostRegion*);
84         
85         uint32_t get_fill_color ();
86
87         virtual void entered () {}
88         virtual void exited () {}
89
90         void enable_display(bool yn) { _enable_display = yn; }
91         
92         static sigc::signal<void,RegionView*> RegionViewGoingAway;
93         
94   protected:
95         
96         /** Allows derived types to specify their visibility requirements
97      * to the TimeAxisViewItem parent class
98      */
99     RegionView (ArdourCanvas::Group *, 
100                 TimeAxisView&,
101                 boost::shared_ptr<ARDOUR::Region>,
102                 double      samples_per_unit,
103                 Gdk::Color& basic_color,
104                 bool recording,
105                 TimeAxisViewItem::Visibility);
106     
107     virtual void region_resized (ARDOUR::Change);
108     virtual void region_muted ();
109     void         region_locked ();
110     void         region_opacity ();
111     void         region_layered ();
112     virtual void region_renamed ();
113     void         region_sync_changed ();
114
115     Glib::ustring make_name () const;
116
117     static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
118     void        lock_toggle ();
119
120     virtual void set_colors ();
121     virtual void compute_colors (Gdk::Color&);
122     virtual void set_frame_color ();
123     virtual void reset_width_dependent_items (double pixel_width);
124
125     virtual void color_handler () {}
126         
127     boost::shared_ptr<ARDOUR::Region> _region;
128     
129     ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position 
130     ArdourCanvas::Line* sync_line; ///< polgyon for sync position 
131
132     RegionEditor* editor;
133
134     vector<ControlPoint *> control_points;
135     double current_visible_sync_position;
136
137     bool    valid; ///< see StreamView::redisplay_diskstream() 
138     bool    _enable_display; ///< see StreamView::redisplay_diskstream() 
139     double  _pixel_width;
140     double  _height;
141     bool    in_destructor;
142     
143     bool             wait_for_data;
144     sigc::connection data_ready_connection;
145     
146     vector<GhostRegion*> ghosts;
147         
148         typedef std::map<const ARDOUR::Parameter, boost::shared_ptr<AutomationRegionView> > AutomationChildren;
149         AutomationChildren _automation_children;
150 };
151
152 #endif /* __gtk_ardour_region_view_h__ */