2 Copyright (C) 2001-2006 Paul Davis
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.
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.
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.
19 #ifndef __gtk_ardour_region_view_h__
20 #define __gtk_ardour_region_view_h__
28 #include <sigc++/signal.h>
29 #include "ardour/region.h"
30 #include "ardour/beats_samples_converter.h"
32 #include "canvas/fwd.h"
34 #include "time_axis_view_item.h"
35 #include "automation_line.h"
41 class AutomationTimeAxisView;
42 class AutomationRegionView;
44 namespace ArdourCanvas {
49 class RegionView : public TimeAxisViewItem
52 RegionView (ArdourCanvas::Container* parent,
53 TimeAxisView& time_view,
54 boost::shared_ptr<ARDOUR::Region> region,
55 double samples_per_pixel,
57 bool automation = false);
59 RegionView (const RegionView& other);
60 RegionView (const RegionView& other, boost::shared_ptr<ARDOUR::Region> other_region);
64 virtual void set_selected (bool yn) {
65 _region->set_selected_for_solo(yn);
66 TimeAxisViewItem::set_selected(yn);
69 virtual void init (bool wait_for_data);
71 boost::shared_ptr<ARDOUR::Region> region() const { return _region; }
73 bool is_valid() const { return valid; }
75 void set_valid (bool yn) { valid = yn; }
77 virtual void set_height (double);
78 virtual void set_samples_per_pixel (double);
79 virtual bool set_duration (samplecnt_t, void*);
81 void move (double xdelta, double ydelta);
84 void lower_to_bottom ();
86 bool set_position(samplepos_t pos, void* src, double* delta = 0);
88 virtual void show_region_editor ();
89 void hide_region_editor ();
91 virtual void region_changed (const PBD::PropertyChange&);
93 uint32_t get_fill_color () const;
95 virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
96 void remove_ghost_in (TimeAxisView&);
97 void remove_ghost (GhostRegion*);
99 virtual void entered () {}
100 virtual void exited () {}
102 virtual void enable_display(bool yn) { _enable_display = yn; }
103 virtual void update_coverage_samples (LayerDisplay);
105 static PBD::Signal1<void,RegionView*> RegionViewGoingAway;
107 /** Called when a front trim is about to begin */
108 virtual void trim_front_starting () {}
110 bool trim_front (samplepos_t, bool, const int32_t sub_num);
112 /** Called when a start trim has finished */
113 virtual void trim_front_ending () {}
115 bool trim_end (samplepos_t, bool, const int32_t sub_num);
116 void move_contents (ARDOUR::sampleoffset_t);
117 virtual void thaw_after_trim ();
119 void set_silent_samples (const ARDOUR::AudioIntervalResult&, double threshold);
120 void drop_silent_samples ();
121 void hide_silent_samples ();
123 struct PositionOrder {
124 bool operator()(const RegionView* a, const RegionView* b) {
125 return a->region()->position() < b->region()->position();
129 ARDOUR::MusicSample snap_sample_to_sample (ARDOUR::sampleoffset_t, bool ensure_snap = false) const;
133 /** Allows derived types to specify their visibility requirements
134 * to the TimeAxisViewItem parent class
136 RegionView (ArdourCanvas::Container *,
138 boost::shared_ptr<ARDOUR::Region>,
139 double samples_per_pixel,
140 uint32_t basic_color,
142 TimeAxisViewItem::Visibility);
144 bool canvas_group_event (GdkEvent*);
146 virtual void region_resized (const PBD::PropertyChange&);
147 virtual void region_muted ();
148 void region_locked ();
149 void region_opacity ();
150 virtual void region_renamed ();
151 void region_sync_changed ();
153 std::string make_name () const;
155 static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
158 virtual void set_colors ();
159 virtual void set_sync_mark_color ();
160 virtual void reset_width_dependent_items (double pixel_width);
162 virtual void color_handler () {}
164 boost::shared_ptr<ARDOUR::Region> _region;
166 ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
167 ArdourCanvas::Line* sync_line; ///< polgyon for sync position
169 RegionEditor* editor;
171 std::vector<ControlPoint *> control_points;
172 double current_visible_sync_position;
174 bool valid; ///< see StreamView::redisplay_diskstream()
175 bool _enable_display; ///< see StreamView::redisplay_diskstream()
181 std::vector<GhostRegion*> ghosts;
183 /** a list of rectangles which are used in stacked display mode to colour
184 * different bits of regions according to whether or not they are the one
185 * that will be played at any given time.
187 std::list<ArdourCanvas::Rectangle*> _coverage_samples;
189 /** a list of rectangles used to show silent segments
191 std::list<ArdourCanvas::Rectangle*> _silent_samples;
192 /** a list of rectangles used to show the current silence threshold
194 std::list<ArdourCanvas::Rectangle*> _silent_threshold_samples;
195 /** a text item to display strip silence statistics */
196 ArdourCanvas::Text* _silence_text;
199 #endif /* __gtk_ardour_region_view_h__ */