Fix to stacked layering for the case when a region is dragged to overlap another...
[ardour.git] / gtk2_ardour / streamview.cc
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 #include <cmath>
20
21 #include <gtkmm.h>
22
23 #include <gtkmm2ext/gtk_ui.h>
24
25 #include <ardour/playlist.h>
26 #include <ardour/region.h>
27 #include <ardour/source.h>
28 #include <ardour/diskstream.h>
29 #include <ardour/track.h>
30
31 #include "streamview.h"
32 #include "region_view.h"
33 #include "route_time_axis.h"
34 #include "canvas-waveview.h"
35 #include "canvas-simplerect.h"
36 #include "region_selection.h"
37 #include "selection.h"
38 #include "public_editor.h"
39 #include "ardour_ui.h"
40 #include "rgb_macros.h"
41 #include "gui_thread.h"
42 #include "utils.h"
43
44 using namespace ARDOUR;
45 using namespace PBD;
46 using namespace Editing;
47
48 StreamView::StreamView (RouteTimeAxisView& tv, ArdourCanvas::Group* group)
49         : _trackview (tv)
50         , canvas_group(group ? group : new ArdourCanvas::Group(*_trackview.canvas_display))
51         , canvas_rect(new ArdourCanvas::SimpleRect (*canvas_group))
52         , _samples_per_unit(_trackview.editor.get_current_zoom())
53         , rec_updating(false)
54         , rec_active(false)
55         , use_rec_regions(tv.editor.show_waveforms_recording())
56         , region_color(_trackview.color())
57         , stream_base_color(0xFFFFFFFF)
58         , layers(1)
59         , height(tv.height)
60         , layer_display(Overlaid)
61         , last_rec_data_frame(0)
62 {
63         /* set_position() will position the group */
64
65         canvas_rect = new ArdourCanvas::SimpleRect (*canvas_group);
66         canvas_rect->property_x1() = 0.0;
67         canvas_rect->property_y1() = 0.0;
68         canvas_rect->property_x2() = _trackview.editor.frame_to_pixel (max_frames);
69         canvas_rect->property_y2() = (double) tv.height;
70         canvas_rect->property_outline_what() = (guint32) (0x2|0x8);  // outline RHS and bottom 
71         // (Fill/Outline colours set in derived classes)
72
73         canvas_rect->signal_event().connect (bind (mem_fun (_trackview.editor, &PublicEditor::canvas_stream_view_event), canvas_rect, &_trackview));
74
75         if (_trackview.is_track()) {
76                 _trackview.track()->DiskstreamChanged.connect (mem_fun (*this, &StreamView::diskstream_changed));
77                 _trackview.session().TransportStateChange.connect (mem_fun (*this, &StreamView::transport_changed));
78                 _trackview.session().TransportLooped.connect (mem_fun (*this, &StreamView::transport_looped));
79                 _trackview.get_diskstream()->RecordEnableChanged.connect (mem_fun (*this, &StreamView::rec_enable_changed));
80                 _trackview.session().RecordStateChanged.connect (mem_fun (*this, &StreamView::sess_rec_enable_changed));
81         } 
82
83         ColorsChanged.connect (mem_fun (*this, &StreamView::color_handler));
84 }
85
86 StreamView::~StreamView ()
87 {
88         undisplay_diskstream ();
89         delete canvas_group;
90 }
91
92 void
93 StreamView::attach ()
94 {
95         if (_trackview.is_track()) {
96                 display_diskstream (_trackview.get_diskstream());
97         }
98 }
99
100 int
101 StreamView::set_position (gdouble x, gdouble y)
102 {
103         canvas_group->property_x() = x;
104         canvas_group->property_y() = y;
105         return 0;
106 }
107
108 int
109 StreamView::set_height (double h)
110 {
111         /* limit the values to something sane-ish */
112         if (h < 10.0 || h > 1000.0) {
113                 return -1;
114         }
115
116         if (canvas_rect->property_y2() == h) {
117                 return 0;
118         }
119
120         height = h;
121         update_contents_y_position_and_height ();
122         return 0;
123 }
124
125 int 
126 StreamView::set_samples_per_unit (gdouble spp)
127 {
128         RegionViewList::iterator i;
129
130         if (spp < 1.0) {
131                 return -1;
132         }
133
134         _samples_per_unit = spp;
135
136         for (i = region_views.begin(); i != region_views.end(); ++i) {
137                 (*i)->set_samples_per_unit (spp);
138         }
139
140         for (vector<RecBoxInfo>::iterator xi = rec_rects.begin(); xi != rec_rects.end(); ++xi) {
141                 RecBoxInfo &recbox = (*xi);
142                 
143                 gdouble xstart = _trackview.editor.frame_to_pixel ( recbox.start );
144                 gdouble xend = _trackview.editor.frame_to_pixel ( recbox.start + recbox.length );
145
146                 recbox.rectangle->property_x1() = xstart;
147                 recbox.rectangle->property_x2() = xend;
148         }
149
150         return 0;
151 }
152
153 void
154 StreamView::add_region_view (boost::shared_ptr<Region> r)
155 {
156         add_region_view_internal (r, true);
157 }
158
159 void
160 StreamView::remove_region_view (boost::weak_ptr<Region> weak_r)
161 {
162         ENSURE_GUI_THREAD (bind (mem_fun (*this, &StreamView::remove_region_view), weak_r));
163
164         boost::shared_ptr<Region> r (weak_r.lock());
165
166         if (!r) {
167                 return;
168         }
169
170         for (list<RegionView *>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
171                 if (((*i)->region()) == r) {
172                         delete *i;
173                         region_views.erase (i);
174                         break;
175                 }
176         }
177 }
178
179 void
180 StreamView::undisplay_diskstream ()
181 {
182         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
183                 delete *i;
184         }
185
186         region_views.clear();
187 }
188
189 void
190 StreamView::display_diskstream (boost::shared_ptr<Diskstream> ds)
191 {
192         playlist_change_connection.disconnect();
193         playlist_changed (ds);
194         playlist_change_connection = ds->PlaylistChanged.connect (bind (mem_fun (*this, &StreamView::playlist_changed), ds));
195 }
196
197 void
198 StreamView::playlist_modified_weak (boost::weak_ptr<Diskstream> ds)
199 {
200         boost::shared_ptr<Diskstream> sp (ds.lock());
201         if (!sp) {
202                 return;
203         }
204
205         playlist_modified (sp);
206 }
207
208 void
209 StreamView::playlist_modified (boost::shared_ptr<Diskstream> ds)
210 {
211         /* we do not allow shared_ptr<T> to be bound to slots */
212         ENSURE_GUI_THREAD (bind (mem_fun (*this, &StreamView::playlist_modified_weak), ds));
213
214         /* update layers count and the y positions and heights of our regions */
215         if (ds->playlist()) {
216                 layers = ds->playlist()->top_layer() + 1;
217                 update_contents_y_position_and_height ();
218                 redisplay_diskstream ();
219         }
220 }
221
222 void
223 StreamView::playlist_changed (boost::shared_ptr<Diskstream> ds)
224 {
225         /* XXX: binding to a shared_ptr, is this ok? */
226         ENSURE_GUI_THREAD (bind (mem_fun (*this, &StreamView::playlist_changed), ds));
227
228         /* disconnect from old playlist */
229
230         for (vector<sigc::connection>::iterator i = playlist_connections.begin(); i != playlist_connections.end(); ++i) {
231                 (*i).disconnect();
232         }
233         
234         playlist_connections.clear();
235         undisplay_diskstream ();
236
237         /* update layers count and the y positions and heights of our regions */
238         layers = ds->playlist()->top_layer() + 1;
239         update_contents_y_position_and_height ();
240         
241         /* draw it */
242         redisplay_diskstream ();
243
244         /* catch changes */
245
246         playlist_connections.push_back (ds->playlist()->Modified.connect (bind (mem_fun (*this, &StreamView::playlist_modified_weak), ds)));
247 }
248
249 void
250 StreamView::diskstream_changed ()
251 {
252         boost::shared_ptr<Track> t;
253
254         if ((t = _trackview.track()) != 0) {
255                 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun (*this, &StreamView::display_diskstream), t->diskstream()));
256         } else {
257                 Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &StreamView::undisplay_diskstream));
258         }
259 }
260
261 void
262 StreamView::apply_color (Gdk::Color& color, ColorTarget target)
263
264 {
265         list<RegionView *>::iterator i;
266
267         switch (target) {
268         case RegionColor:
269                 region_color = color;
270                 for (i = region_views.begin(); i != region_views.end(); ++i) {
271                         (*i)->set_color (region_color);
272                 }
273                 break;
274                 
275         case StreamBaseColor:
276                 stream_base_color = RGBA_TO_UINT (
277                         color.get_red_p(), color.get_green_p(), color.get_blue_p(), 255);
278                 canvas_rect->property_fill_color_rgba() = stream_base_color;
279                 break;
280         }
281 }
282
283 void
284 StreamView::region_layered (RegionView* rv)
285 {
286         rv->get_canvas_group()->lower_to_bottom();
287
288         /* don't ever leave it at the bottom, since then it doesn't
289            get events - the  parent group does instead ...
290         */
291         
292         /* this used to be + 1, but regions to the left ended up below
293           ..something.. and couldn't receive events.  why?  good question.
294         */
295         /* and now it's + 3 for midi note separator lines */
296         rv->get_canvas_group()->raise (rv->region()->layer() + 3);
297 }
298
299 void
300 StreamView::rec_enable_changed ()
301 {
302         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &StreamView::setup_rec_box));
303 }
304
305 void
306 StreamView::sess_rec_enable_changed ()
307 {
308         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &StreamView::setup_rec_box));
309 }
310
311 void
312 StreamView::transport_changed()
313 {
314         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &StreamView::setup_rec_box));
315 }
316
317 void
318 StreamView::transport_looped()
319 {
320         // to force a new rec region
321         rec_active = false;
322         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &StreamView::setup_rec_box));
323 }
324
325 void
326 StreamView::update_rec_box ()
327 {
328         if (rec_active && rec_rects.size() > 0) {
329                 /* only update the last box */
330                 RecBoxInfo & rect = rec_rects.back();
331                 nframes_t at = _trackview.get_diskstream()->current_capture_end();
332                 double xstart;
333                 double xend;
334                 
335                 switch (_trackview.track()->mode()) {
336                 case Normal:
337                         rect.length = at - rect.start;
338                         xstart = _trackview.editor.frame_to_pixel (rect.start);
339                         xend = _trackview.editor.frame_to_pixel (at);
340                         break;
341                         
342                 case Destructive:
343                         rect.length = 2;
344                         xstart = _trackview.editor.frame_to_pixel (_trackview.get_diskstream()->current_capture_start());
345                         xend = _trackview.editor.frame_to_pixel (at);
346                         break;
347                 }
348                 
349                 rect.rectangle->property_x1() = xstart;
350                 rect.rectangle->property_x2() = xend;
351         }
352 }
353         
354 RegionView*
355 StreamView::find_view (boost::shared_ptr<const Region> region)
356 {
357         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
358
359                 if ((*i)->region() == region) {
360                         return *i;
361                 }
362         }
363         return 0;
364 }
365         
366 void
367 StreamView::foreach_regionview (sigc::slot<void,RegionView*> slot)
368 {
369         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
370                 slot (*i);
371         }
372 }
373
374 void
375 StreamView::set_selected_regionviews (RegionSelection& regions)
376 {
377         bool selected;
378
379         // cerr << _trackview.name() << " (selected = " << regions.size() << ")" << endl;
380         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
381                 
382                 selected = false;
383                 
384                 for (RegionSelection::iterator ii = regions.begin(); ii != regions.end(); ++ii) {
385                         if (*i == *ii) {
386                                 selected = true;
387                         }
388                 }
389                 
390                 // cerr << "\tregion " << (*i)->region().name() << " selected = " << selected << endl;
391                 (*i)->set_selected (selected);
392         }
393 }
394
395 void
396 StreamView::get_selectables (nframes_t start, nframes_t end, list<Selectable*>& results)
397 {
398         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
399                 if ((*i)->region()->coverage(start, end) != OverlapNone) {
400                         results.push_back (*i);
401                 }
402         }
403 }
404
405 void
406 StreamView::get_inverted_selectables (Selection& sel, list<Selectable*>& results)
407 {
408         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
409                 if (!sel.regions.contains (*i)) {
410                         results.push_back (*i);
411                 }
412         }
413 }
414
415 void
416 StreamView::update_contents_y_position_and_height ()
417 {
418         canvas_rect->property_y2() = height;
419
420         const double lh = height / layers;
421
422         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
423                 switch (layer_display) {
424                 case Overlaid:
425                         (*i)->set_y_position_and_height (0, height);
426                         break;
427                 case Stacked:
428                         double const y = (*i)->region()->layer() * lh;
429                         (*i)->set_y_position_and_height (y, lh);
430                         break;
431                 }
432         }
433
434         for (vector<RecBoxInfo>::iterator i = rec_rects.begin(); i != rec_rects.end(); ++i) {
435                 i->rectangle->property_y2() = height - 1.0;
436         }
437 }
438
439 void
440 StreamView::set_layer_display (LayerDisplay d)
441 {
442         layer_display = d;
443         update_contents_y_position_and_height ();
444 }