71c7e5383a8bda65c9e92b2b6f560d580e3574e3
[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 (nframes64_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(nframes64_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   protected:
100
101         /** Allows derived types to specify their visibility requirements
102          * to the TimeAxisViewItem parent class
103          */
104         RegionView (ArdourCanvas::Group *,
105                     TimeAxisView&,
106                     boost::shared_ptr<ARDOUR::Region>,
107                     double samples_per_unit,
108                     Gdk::Color const & basic_color,
109                     bool recording,
110                     TimeAxisViewItem::Visibility);
111         
112         virtual void region_resized (const PBD::PropertyChange&);
113         virtual void region_muted ();
114         void         region_locked ();
115         void         region_opacity ();
116         virtual void region_renamed ();
117         void         region_sync_changed ();
118         
119         std::string make_name () const;
120         
121         static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
122         void        lock_toggle ();
123         
124         virtual void set_colors ();
125         virtual void set_frame_color ();
126         virtual void reset_width_dependent_items (double pixel_width);
127         
128         virtual void color_handler () {}
129         
130         boost::shared_ptr<ARDOUR::Region> _region;
131         
132         ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
133         ArdourCanvas::Line* sync_line; ///< polgyon for sync position
134         
135         RegionEditor* editor;
136         
137         std::vector<ControlPoint *> control_points;
138         double current_visible_sync_position;
139
140         bool    valid; ///< see StreamView::redisplay_diskstream()
141         bool    _enable_display; ///< see StreamView::redisplay_diskstream()
142         double  _pixel_width;
143         bool    in_destructor;
144         
145         bool wait_for_data;
146         
147         std::vector<GhostRegion*> ghosts;
148         
149         /** a list of rectangles which are used in stacked display mode to colour
150             different bits of regions according to whether or not they are the one
151             that will be played at any given time.
152         */
153         std::list<ArdourCanvas::SimpleRect*> _coverage_frames;
154
155         ARDOUR::BeatsFramesConverter _time_converter;
156 };
157
158 #endif /* __gtk_ardour_region_view_h__ */