1e8c09bdbadd28aeca330b5f192f6ee81dc3888d
[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 const &   basic_color,
49                     bool                 automation = false);
50
51         RegionView (const RegionView& other);
52         RegionView (const RegionView& other, boost::shared_ptr<ARDOUR::Region> other_region);
53
54         ~RegionView ();
55
56         virtual void init (Gdk::Color const & base_color, bool wait_for_data);
57
58         boost::shared_ptr<ARDOUR::Region> region() const { return _region; }
59
60         bool is_valid() const    { return valid; }
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 (framecnt_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(framepos_t pos, void* src, double* delta = 0);
74         void fake_set_opaque (bool yn);
75
76         virtual void show_region_editor ();
77         void hide_region_editor ();
78
79         virtual void region_changed (const PBD::PropertyChange&);
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 (bool) {}
88         virtual void exited () {}
89
90         virtual void enable_display(bool yn) { _enable_display = yn; }
91         virtual void update_coverage_frames (LayerDisplay);
92
93         static PBD::Signal1<void,RegionView*> RegionViewGoingAway;
94
95         ARDOUR::BeatsFramesConverter const & time_converter () {
96                 return _time_converter;
97         }
98
99         void trim_start (framepos_t, bool);
100         void trim_end (framepos_t, bool);
101         void trim_contents (framepos_t, bool, bool);
102         virtual void thaw_after_trim ();
103
104   protected:
105
106         /** Allows derived types to specify their visibility requirements
107          * to the TimeAxisViewItem parent class
108          */
109         RegionView (ArdourCanvas::Group *,
110                     TimeAxisView&,
111                     boost::shared_ptr<ARDOUR::Region>,
112                     double samples_per_unit,
113                     Gdk::Color const & basic_color,
114                     bool recording,
115                     TimeAxisViewItem::Visibility);
116         
117         virtual void region_resized (const PBD::PropertyChange&);
118         virtual void region_muted ();
119         void         region_locked ();
120         void         region_opacity ();
121         virtual void region_renamed ();
122         void         region_sync_changed ();
123         
124         std::string make_name () const;
125         
126         static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
127         void        lock_toggle ();
128         
129         virtual void set_colors ();
130         virtual void set_frame_color ();
131         virtual void reset_width_dependent_items (double pixel_width);
132         
133         virtual void color_handler () {}
134         
135         boost::shared_ptr<ARDOUR::Region> _region;
136         
137         ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
138         ArdourCanvas::Line* sync_line; ///< polgyon for sync position
139         
140         RegionEditor* editor;
141         
142         std::vector<ControlPoint *> control_points;
143         double current_visible_sync_position;
144
145         bool    valid; ///< see StreamView::redisplay_diskstream()
146         bool    _enable_display; ///< see StreamView::redisplay_diskstream()
147         double  _pixel_width;
148         bool    in_destructor;
149         
150         bool wait_for_data;
151         
152         std::vector<GhostRegion*> ghosts;
153         
154         /** a list of rectangles which are used in stacked display mode to colour
155             different bits of regions according to whether or not they are the one
156             that will be played at any given time.
157         */
158         std::list<ArdourCanvas::SimpleRect*> _coverage_frames;
159
160         ARDOUR::BeatsFramesConverter _time_converter;
161 };
162
163 #endif /* __gtk_ardour_region_view_h__ */