25c4eb871408f91ee518c68849af57915d16bb26
[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 #include "ardour/beats_frames_converter.h"
29
30 #include "time_axis_view_item.h"
31 #include "automation_line.h"
32 #include "enums.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         void set_valid (bool yn) { valid = yn; }
62         
63         virtual void set_height (double);
64         virtual void set_samples_per_unit (double);
65         virtual bool set_duration (nframes_t, void*);
66         
67         void move (double xdelta, double ydelta);
68         
69         void raise_to_top ();
70         void lower_to_bottom ();
71
72         bool set_position(nframes_t pos, void* src, double* delta = 0);
73         void fake_set_opaque (bool yn);
74         
75         virtual void show_region_editor () {}
76         virtual void hide_region_editor();
77         
78         virtual void region_changed (ARDOUR::Change);
79         
80         virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
81         void remove_ghost_in (TimeAxisView&);
82         void remove_ghost (GhostRegion*);
83         
84         uint32_t get_fill_color ();
85
86         virtual void entered () {}
87         virtual void exited () {}
88
89         void enable_display(bool yn) { _enable_display = yn; }
90         void update_coverage_frames (LayerDisplay);
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     virtual void region_renamed ();
112     void         region_sync_changed ();
113
114     Glib::ustring make_name () const;
115
116     static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
117     void        lock_toggle ();
118
119     virtual void set_colors ();
120     virtual void compute_colors (Gdk::Color&);
121     virtual void set_frame_color ();
122     virtual void reset_width_dependent_items (double pixel_width);
123
124     virtual void color_handler () {}
125         
126     boost::shared_ptr<ARDOUR::Region> _region;
127     
128     ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position 
129     ArdourCanvas::Line* sync_line; ///< polgyon for sync position 
130
131     RegionEditor* editor;
132
133     std::vector<ControlPoint *> control_points;
134     double current_visible_sync_position;
135
136     bool    valid; ///< see StreamView::redisplay_diskstream() 
137     bool    _enable_display; ///< see StreamView::redisplay_diskstream() 
138     double  _pixel_width;
139     double  _height;
140     bool    in_destructor;
141     
142     bool             wait_for_data;
143     sigc::connection data_ready_connection;
144     
145     std::vector<GhostRegion*> ghosts;
146
147         /** a list of rectangles which are used in stacked display mode to colour
148             different bits of regions according to whether or not they are the one
149             that will be played at any given time.
150         */
151         std::list<ArdourCanvas::SimpleRect*> _coverage_frames;
152
153         ARDOUR::BeatsFramesConverter _time_converter;
154 };
155
156 #endif /* __gtk_ardour_region_view_h__ */