add an example script to show/hide TAVs
[ardour.git] / gtk2_ardour / audio_region_view.cc
1 /*
2     Copyright (C) 2001-2006 Paul Davis
3
4     This program is free software; you can r>edistribute 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 #include <cassert>
21 #include <algorithm>
22 #include <vector>
23
24 #include <boost/scoped_array.hpp>
25
26 #include <gtkmm.h>
27
28 #include <gtkmm2ext/gtk_ui.h>
29
30 #include "ardour/playlist.h"
31 #include "ardour/audioregion.h"
32 #include "ardour/audiosource.h"
33 #include "ardour/profile.h"
34 #include "ardour/session.h"
35
36 #include "pbd/memento_command.h"
37 #include "pbd/stacktrace.h"
38
39 #include "evoral/Curve.hpp"
40
41 #include "canvas/rectangle.h"
42 #include "canvas/polygon.h"
43 #include "canvas/poly_line.h"
44 #include "canvas/line.h"
45 #include "canvas/text.h"
46 #include "canvas/xfade_curve.h"
47 #include "canvas/debug.h"
48 #include "canvas/utils.h"
49 #include "canvas/colors.h"
50
51 #include "streamview.h"
52 #include "audio_region_view.h"
53 #include "audio_time_axis.h"
54 #include "public_editor.h"
55 #include "audio_region_editor.h"
56 #include "audio_streamview.h"
57 #include "region_gain_line.h"
58 #include "control_point.h"
59 #include "ghostregion.h"
60 #include "audio_time_axis.h"
61 #include "rgb_macros.h"
62 #include "gui_thread.h"
63 #include "ui_config.h"
64
65 #include "pbd/i18n.h"
66
67 #define MUTED_ALPHA 48
68
69 using namespace std;
70 using namespace ARDOUR;
71 using namespace PBD;
72 using namespace Editing;
73 using namespace ArdourCanvas;
74
75 static double const handle_size = 10; /* height of fade handles */
76
77 Cairo::RefPtr<Cairo::Pattern> AudioRegionView::pending_peak_pattern;
78
79 static Cairo::RefPtr<Cairo::Pattern> create_pending_peak_pattern() {
80         cairo_surface_t * is = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, 8, 8);
81
82         // create checker pattern
83         unsigned char *img = cairo_image_surface_get_data (is);
84         cairo_surface_flush (is);
85         const int stride = cairo_image_surface_get_stride (is);
86
87         for (int y = 0; y < 8; ++y) {
88                 for (int x = 0; x < 8; ++x) {
89                         const int off = (y * stride + x * 4);
90                         uint32_t *pixel = (uint32_t*) &img[off];
91                         if ((x < 4) ^ (y < 4)) {
92                                 *pixel = 0xa0000000;
93                         } else {
94                                 *pixel = 0x40000000;
95                         }
96                 }
97         }
98         cairo_surface_mark_dirty (is);
99
100         cairo_pattern_t* pat = cairo_pattern_create_for_surface (is);
101         cairo_pattern_set_extend (pat, CAIRO_EXTEND_REPEAT);
102         Cairo::RefPtr<Cairo::Pattern> p (new Cairo::Pattern (pat, false));
103         cairo_surface_destroy (is);
104         return p;
105 }
106
107 AudioRegionView::AudioRegionView (ArdourCanvas::Container *parent, RouteTimeAxisView &tv, boost::shared_ptr<AudioRegion> r, double spu,
108                                   uint32_t basic_color)
109         : RegionView (parent, tv, r, spu, basic_color)
110         , sync_mark(0)
111         , fade_in_handle(0)
112         , fade_out_handle(0)
113         , fade_in_trim_handle(0)
114         , fade_out_trim_handle(0)
115         , pending_peak_data(0)
116         , start_xfade_curve (0)
117         , start_xfade_rect (0)
118         , _start_xfade_visible (false)
119         , end_xfade_curve (0)
120         , end_xfade_rect (0)
121         , _end_xfade_visible (false)
122         , _amplitude_above_axis(1.0)
123         , trim_fade_in_drag_active(false)
124         , trim_fade_out_drag_active(false)
125 {
126         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &AudioRegionView::parameter_changed));
127 }
128
129 AudioRegionView::AudioRegionView (ArdourCanvas::Container *parent, RouteTimeAxisView &tv, boost::shared_ptr<AudioRegion> r, double spu,
130                                   uint32_t basic_color, bool recording, TimeAxisViewItem::Visibility visibility)
131         : RegionView (parent, tv, r, spu, basic_color, recording, visibility)
132         , sync_mark(0)
133         , fade_in_handle(0)
134         , fade_out_handle(0)
135         , fade_in_trim_handle(0)
136         , fade_out_trim_handle(0)
137         , pending_peak_data(0)
138         , start_xfade_curve (0)
139         , start_xfade_rect (0)
140         , _start_xfade_visible (false)
141         , end_xfade_curve (0)
142         , end_xfade_rect (0)
143         , _end_xfade_visible (false)
144         , _amplitude_above_axis(1.0)
145         , trim_fade_in_drag_active(false)
146         , trim_fade_out_drag_active(false)
147 {
148         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &AudioRegionView::parameter_changed));
149 }
150
151 AudioRegionView::AudioRegionView (const AudioRegionView& other, boost::shared_ptr<AudioRegion> other_region)
152         : RegionView (other, boost::shared_ptr<Region> (other_region))
153         , fade_in_handle(0)
154         , fade_out_handle(0)
155         , fade_in_trim_handle(0)
156         , fade_out_trim_handle(0)
157         , pending_peak_data(0)
158         , start_xfade_curve (0)
159         , start_xfade_rect (0)
160         , _start_xfade_visible (false)
161         , end_xfade_curve (0)
162         , end_xfade_rect (0)
163         , _end_xfade_visible (false)
164         , _amplitude_above_axis (other._amplitude_above_axis)
165         , trim_fade_in_drag_active(false)
166         , trim_fade_out_drag_active(false)
167 {
168         init (true);
169
170         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &AudioRegionView::parameter_changed));
171 }
172
173 void
174 AudioRegionView::init (bool wfd)
175 {
176         // FIXME: Some redundancy here with RegionView::init.  Need to figure out
177         // where order is important and where it isn't...
178
179         if (!pending_peak_pattern) {
180                 pending_peak_pattern = create_pending_peak_pattern();
181         }
182
183         // needs to be created first, RegionView::init() calls set_height()
184         pending_peak_data = new ArdourCanvas::Rectangle (group);
185         CANVAS_DEBUG_NAME (pending_peak_data, string_compose ("pending peak rectangle for %1", region()->name()));
186         pending_peak_data->set_outline_color (ArdourCanvas::rgba_to_color (0, 0, 0, 0.0));
187         pending_peak_data->set_pattern (pending_peak_pattern);
188         pending_peak_data->set_data ("regionview", this);
189         pending_peak_data->hide ();
190
191         RegionView::init (wfd);
192
193         _amplitude_above_axis = 1.0;
194
195         create_waves ();
196
197         if (!_recregion) {
198                 fade_in_handle = new ArdourCanvas::Rectangle (group);
199                 CANVAS_DEBUG_NAME (fade_in_handle, string_compose ("fade in handle for %1", region()->name()));
200                 fade_in_handle->set_outline_color (ArdourCanvas::rgba_to_color (0, 0, 0, 1.0));
201                 fade_in_handle->set_fill_color (UIConfiguration::instance().color ("inactive fade handle"));
202                 fade_in_handle->set_data ("regionview", this);
203                 fade_in_handle->hide ();
204
205                 fade_out_handle = new ArdourCanvas::Rectangle (group);
206                 CANVAS_DEBUG_NAME (fade_out_handle, string_compose ("fade out handle for %1", region()->name()));
207                 fade_out_handle->set_outline_color (ArdourCanvas::rgba_to_color (0, 0, 0, 1.0));
208                 fade_out_handle->set_fill_color (UIConfiguration::instance().color ("inactive fade handle"));
209                 fade_out_handle->set_data ("regionview", this);
210                 fade_out_handle->hide ();
211
212                 fade_in_trim_handle = new ArdourCanvas::Rectangle (group);
213                 CANVAS_DEBUG_NAME (fade_in_handle, string_compose ("fade in trim handle for %1", region()->name()));
214                 fade_in_trim_handle->set_outline_color (ArdourCanvas::rgba_to_color (0, 0, 0, 1.0));
215                 fade_in_trim_handle->set_fill_color (UIConfiguration::instance().color ("inactive fade handle"));
216                 fade_in_trim_handle->set_data ("regionview", this);
217                 fade_in_trim_handle->hide ();
218
219                 fade_out_trim_handle = new ArdourCanvas::Rectangle (group);
220                 CANVAS_DEBUG_NAME (fade_out_handle, string_compose ("fade out trim handle for %1", region()->name()));
221                 fade_out_trim_handle->set_outline_color (ArdourCanvas::rgba_to_color (0, 0, 0, 1.0));
222                 fade_out_trim_handle->set_fill_color (UIConfiguration::instance().color ("inactive fade handle"));
223                 fade_out_trim_handle->set_data ("regionview", this);
224                 fade_out_trim_handle->hide ();
225         }
226
227         setup_fade_handle_positions ();
228
229         if (!trackview.session()->config.get_show_region_fades()) {
230                 set_fade_visibility (false);
231         }
232
233         const string line_name = _region->name() + ":gain";
234
235         gain_line.reset (new AudioRegionGainLine (line_name, *this, *group, audio_region()->envelope()));
236
237         update_envelope_visibility ();
238         gain_line->reset ();
239
240         /* streamview will call set_height() */
241         //set_height (trackview.current_height()); // XXX not correct for Layered mode, but set_height() will fix later.
242
243         region_muted ();
244         region_sync_changed ();
245
246         region_resized (ARDOUR::bounds_change);
247         /* region_resized sets ghost region duration */
248
249         /* region_locked is a synonym for region_renamed () which is called in region_muted() above */
250         //region_locked ();
251
252         envelope_active_changed ();
253         fade_in_active_changed ();
254         fade_out_active_changed ();
255
256         reset_width_dependent_items (_pixel_width);
257
258         if (fade_in_handle) {
259                 fade_in_handle->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_fade_in_handle_event), fade_in_handle, this, false));
260         }
261
262         if (fade_out_handle) {
263                 fade_out_handle->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_fade_out_handle_event), fade_out_handle, this, false));
264         }
265
266         if (fade_in_trim_handle) {
267                 fade_in_trim_handle->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_fade_in_handle_event), fade_in_trim_handle, this, true));
268         }
269
270         if (fade_out_trim_handle) {
271                 fade_out_trim_handle->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_fade_out_handle_event), fade_out_trim_handle, this, true));
272         }
273
274         set_colors ();
275
276         setup_waveform_visibility ();
277
278         /* XXX sync mark drag? */
279 }
280
281 AudioRegionView::~AudioRegionView ()
282 {
283         in_destructor = true;
284
285         RegionViewGoingAway (this); /* EMIT_SIGNAL */
286
287         for (vector<ScopedConnection*>::iterator i = _data_ready_connections.begin(); i != _data_ready_connections.end(); ++i) {
288                 delete *i;
289         }
290         _data_ready_connections.clear ();
291
292         for (list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator i = feature_lines.begin(); i != feature_lines.end(); ++i) {
293                 delete ((*i).second);
294         }
295
296         /* all waveviews etc will be destroyed when the group is destroyed */
297 }
298
299 boost::shared_ptr<ARDOUR::AudioRegion>
300 AudioRegionView::audio_region() const
301 {
302         // "Guaranteed" to succeed...
303         return boost::dynamic_pointer_cast<AudioRegion>(_region);
304 }
305
306 void
307 AudioRegionView::region_changed (const PropertyChange& what_changed)
308 {
309         ENSURE_GUI_THREAD (*this, &AudioRegionView::region_changed, what_changed);
310
311         RegionView::region_changed (what_changed);
312
313         if (what_changed.contains (ARDOUR::Properties::scale_amplitude)) {
314                 region_scale_amplitude_changed ();
315         }
316         if (what_changed.contains (ARDOUR::Properties::fade_in)) {
317                 fade_in_changed ();
318         }
319         if (what_changed.contains (ARDOUR::Properties::fade_out)) {
320                 fade_out_changed ();
321         }
322         if (what_changed.contains (ARDOUR::Properties::fade_in_active)) {
323                 fade_in_active_changed ();
324         }
325         if (what_changed.contains (ARDOUR::Properties::fade_out_active)) {
326                 fade_out_active_changed ();
327         }
328         if (what_changed.contains (ARDOUR::Properties::envelope_active)) {
329                 envelope_active_changed ();
330         }
331         if (what_changed.contains (ARDOUR::Properties::valid_transients)) {
332                 transients_changed ();
333         }
334 }
335
336 void
337 AudioRegionView::fade_in_changed ()
338 {
339         reset_fade_in_shape ();
340 }
341
342 void
343 AudioRegionView::fade_out_changed ()
344 {
345         reset_fade_out_shape ();
346 }
347
348 void
349 AudioRegionView::fade_in_active_changed ()
350 {
351         if (start_xfade_rect) {
352                 if (audio_region()->fade_in_active()) {
353                         start_xfade_rect->set_fill (false);
354                 } else {
355                         start_xfade_rect->set_fill_color (UIConfiguration::instance().color_mod ("inactive crossfade", "inactive crossfade"));
356                         start_xfade_rect->set_fill (true);
357                 }
358         }
359 }
360
361 void
362 AudioRegionView::fade_out_active_changed ()
363 {
364         if (end_xfade_rect) {
365                 if (audio_region()->fade_out_active()) {
366                         end_xfade_rect->set_fill (false);
367                 } else {
368                         end_xfade_rect->set_fill_color (UIConfiguration::instance().color_mod ("inactive crossfade", "inactive crossfade"));
369                         end_xfade_rect->set_fill (true);
370                 }
371         }
372 }
373
374
375 void
376 AudioRegionView::region_scale_amplitude_changed ()
377 {
378         for (uint32_t n = 0; n < waves.size(); ++n) {
379                 waves[n]->gain_changed ();
380         }
381         region_renamed ();
382 }
383
384 void
385 AudioRegionView::region_renamed ()
386 {
387         std::string str = RegionView::make_name ();
388
389         if (audio_region()->speed_mismatch (trackview.session()->frame_rate())) {
390                 str = string ("*") + str;
391         }
392
393         if (_region->muted()) {
394                 str = string ("!") + str;
395         }
396
397
398         boost::shared_ptr<AudioRegion> ar (audio_region());
399         if (ar->scale_amplitude() != 1.0) {
400                 char tmp[32];
401                 snprintf (tmp, 32, " (%.1fdB)", accurate_coefficient_to_dB (ar->scale_amplitude()));
402                 str += tmp;
403         }
404
405         set_item_name (str, this);
406         set_name_text (str);
407 }
408
409 void
410 AudioRegionView::region_resized (const PropertyChange& what_changed)
411 {
412         AudioGhostRegion* agr;
413
414         RegionView::region_resized(what_changed);
415         PropertyChange interesting_stuff;
416
417         interesting_stuff.add (ARDOUR::Properties::start);
418         interesting_stuff.add (ARDOUR::Properties::length);
419
420         if (what_changed.contains (interesting_stuff)) {
421
422                 for (uint32_t n = 0; n < waves.size(); ++n) {
423                         waves[n]->region_resized ();
424                 }
425
426                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
427                         if ((agr = dynamic_cast<AudioGhostRegion*>(*i)) != 0) {
428
429                                 for (vector<WaveView*>::iterator w = agr->waves.begin(); w != agr->waves.end(); ++w) {
430                                         (*w)->region_resized ();
431                                 }
432                         }
433                 }
434
435                 /* hide transient lines that extend beyond the region */
436                 list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
437                 framepos_t first = _region->first_frame();
438                 framepos_t last = _region->last_frame();
439
440                 for (l = feature_lines.begin(); l != feature_lines.end(); ++l) {
441                         if (l->first < first || l->first >= last) {
442                                 l->second->hide();
443                         } else {
444                                 l->second->show();
445                         }
446                 }
447         }
448 }
449
450 void
451 AudioRegionView::reset_width_dependent_items (double pixel_width)
452 {
453         if (pixel_width == _width) {
454                 return;
455         }
456
457         RegionView::reset_width_dependent_items(pixel_width);
458         assert(_pixel_width == pixel_width);
459
460         pending_peak_data->set_x1(pixel_width);
461
462         if (pixel_width <= 20.0 || _height < 5.0 || !trackview.session()->config.get_show_region_fades()) {
463                 if (fade_in_handle)       { fade_in_handle->hide(); }
464                 if (fade_out_handle)      { fade_out_handle->hide(); }
465                 if (fade_in_trim_handle)  { fade_in_trim_handle->hide(); }
466                 if (fade_out_trim_handle) { fade_out_trim_handle->hide(); }
467                 if (start_xfade_rect)     { start_xfade_rect->set_outline (false); }
468                 if (end_xfade_rect)       { end_xfade_rect->set_outline (false); }
469         }
470
471         reset_fade_shapes ();
472
473         /* Update feature lines */
474         AnalysisFeatureList analysis_features;
475         _region->transients (analysis_features);
476
477         if (feature_lines.size () != analysis_features.size ()) {
478                 cerr << "postponed freature line update.\n"; // XXX
479                 // AudioRegionView::transients_changed () will pick up on this
480                 return;
481         }
482
483         framepos_t position = _region->position();
484
485         AnalysisFeatureList::const_iterator i;
486         list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
487         double y1;
488         if (_height >= NAME_HIGHLIGHT_THRESH) {
489                 y1 = _height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 1;
490         } else {
491                 y1 = _height - 1;
492         }
493         for (i = analysis_features.begin(), l = feature_lines.begin(); i != analysis_features.end() && l != feature_lines.end(); ++i, ++l) {
494                 float x_pos = trackview.editor().sample_to_pixel ((*i) - position);
495                 (*l).first = *i;
496                 (*l).second->set (ArdourCanvas::Duple (x_pos, 2.0),
497                                   ArdourCanvas::Duple (x_pos, y1));
498         }
499 }
500
501 void
502 AudioRegionView::region_muted ()
503 {
504         RegionView::region_muted();
505         set_waveform_colors ();
506 }
507
508 void
509 AudioRegionView::setup_fade_handle_positions()
510 {
511         /* position of fade handle offset from the top of the region view */
512         double const handle_pos = 0.0;
513
514         if (fade_in_handle) {
515                 fade_in_handle->set_y0 (handle_pos);
516                 fade_in_handle->set_y1 (handle_pos + handle_size);
517         }
518
519         if (fade_out_handle) {
520                 fade_out_handle->set_y0 (handle_pos);
521                 fade_out_handle->set_y1 (handle_pos + handle_size);
522         }
523
524         if (fade_in_trim_handle) {
525                 fade_in_trim_handle->set_y0 (_height - handle_size);
526                 fade_in_trim_handle->set_y1 (_height);
527         }
528
529         if (fade_out_trim_handle) {
530                 fade_out_trim_handle->set_y0 (_height - handle_size );
531                 fade_out_trim_handle->set_y1 (_height);
532         }
533 }
534
535 void
536 AudioRegionView::set_height (gdouble height)
537 {
538         if (height == _height) {
539                 return;
540         }
541
542         RegionView::set_height (height);
543         pending_peak_data->set_y1 (height);
544
545         uint32_t wcnt = waves.size();
546
547         if (wcnt > 0) {
548
549                 gdouble ht;
550
551                 if (!UIConfiguration::instance().get_show_name_highlight() || (height < NAME_HIGHLIGHT_THRESH)) {
552                         ht = height / (double) wcnt;
553                 } else {
554                         ht = (height - NAME_HIGHLIGHT_SIZE) / (double) wcnt;
555                 }
556
557                 for (uint32_t n = 0; n < wcnt; ++n) {
558
559                         gdouble yoff = floor (ht * n);
560
561                         waves[n]->set_height (ht);
562                         waves[n]->set_y_position (yoff);
563                 }
564         }
565
566         if (gain_line) {
567
568                 if ((height/wcnt) < NAME_HIGHLIGHT_THRESH) {
569                         gain_line->hide ();
570                 } else {
571                         update_envelope_visibility ();
572                 }
573
574                 gain_line->set_height ((uint32_t) rint (height - NAME_HIGHLIGHT_SIZE) - 2);
575         }
576
577         reset_fade_shapes ();
578
579         /* Update heights for any feature lines */
580         framepos_t position = _region->position();
581         list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
582         double y1;
583         if (_height >= NAME_HIGHLIGHT_THRESH) {
584                 y1 = _height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 1;
585         } else {
586                 y1 = _height - 1;
587         }
588         for (l = feature_lines.begin(); l != feature_lines.end(); ++l) {
589                 float pos_x = trackview.editor().sample_to_pixel((*l).first - position);
590                 (*l).second->set (ArdourCanvas::Duple (pos_x, 2.0),
591                                 ArdourCanvas::Duple (pos_x, y1));
592         }
593
594         if (name_text) {
595                 name_text->raise_to_top();
596         }
597
598         setup_fade_handle_positions();
599 }
600
601 void
602 AudioRegionView::reset_fade_shapes ()
603 {
604         if (!trim_fade_in_drag_active) { reset_fade_in_shape (); }
605         if (!trim_fade_out_drag_active) { reset_fade_out_shape (); }
606 }
607
608 void
609 AudioRegionView::reset_fade_in_shape ()
610 {
611         reset_fade_in_shape_width (audio_region(), (framecnt_t) audio_region()->fade_in()->back()->when);
612 }
613
614 void
615 AudioRegionView::reset_fade_in_shape_width (boost::shared_ptr<AudioRegion> ar, framecnt_t width, bool drag_active)
616 {
617         trim_fade_in_drag_active = drag_active;
618         if (fade_in_handle == 0) {
619                 return;
620         }
621
622         /* smallest size for a fade is 64 frames */
623
624         width = std::max ((framecnt_t) 64, width);
625
626         /* round here to prevent little visual glitches with sub-pixel placement */
627         double const pwidth = floor (width / samples_per_pixel);
628         double const handle_left = pwidth;
629
630         /* Put the fade in handle so that its left side is at the end-of-fade line */
631         fade_in_handle->set_x0 (handle_left);
632         fade_in_handle->set_x1 (handle_left + handle_size);
633
634         if (fade_in_trim_handle) {
635                 fade_in_trim_handle->set_x0 (0);
636                 fade_in_trim_handle->set_x1 (handle_size);
637         }
638
639         if (fade_in_handle->visible()) {
640                 //see comment for drag_start
641                 entered();
642         }
643
644         if (pwidth < 5) {
645                 hide_start_xfade();
646                 return;
647         }
648
649         if (!trackview.session()->config.get_show_region_fades()) {
650                 hide_start_xfade ();
651                 return;
652         }
653
654         double effective_height;
655
656         if (_height >= NAME_HIGHLIGHT_THRESH) {
657                 effective_height = _height - NAME_HIGHLIGHT_SIZE;
658         } else {
659                 effective_height = _height;
660         }
661
662         /* points *MUST* be in anti-clockwise order */
663
664         Points points;
665         Points::size_type pi;
666         boost::shared_ptr<const Evoral::ControlList> list (audio_region()->fade_in());
667         Evoral::ControlList::const_iterator x;
668         double length = list->length();
669
670         points.assign (list->size(), Duple());
671
672         for (x = list->begin(), pi = 0; x != list->end(); ++x, ++pi) {
673                 points[pi].x = (pwidth * ((*x)->when/length));
674                 points[pi].y = effective_height - ((*x)->value * (effective_height - 1.));
675         }
676
677         /* draw the line */
678
679         redraw_start_xfade_to (ar, width, points, effective_height, handle_left);
680
681         /* ensure trim handle stays on top */
682         if (frame_handle_start) {
683                 frame_handle_start->raise_to_top();
684         }
685 }
686
687 void
688 AudioRegionView::reset_fade_out_shape ()
689 {
690         reset_fade_out_shape_width (audio_region(), (framecnt_t) audio_region()->fade_out()->back()->when);
691 }
692
693 void
694 AudioRegionView::reset_fade_out_shape_width (boost::shared_ptr<AudioRegion> ar, framecnt_t width, bool drag_active)
695 {
696         trim_fade_out_drag_active = drag_active;
697         if (fade_out_handle == 0) {
698                 return;
699         }
700
701         /* smallest size for a fade is 64 frames */
702
703         width = std::max ((framecnt_t) 64, width);
704
705
706         double const pwidth = floor(trackview.editor().sample_to_pixel (width));
707
708         /* the right edge should be right on the region frame is the pixel
709          * width is zero. Hence the additional + 1.0 at the end.
710          */
711
712         double const handle_right = rint(trackview.editor().sample_to_pixel (_region->length()) - pwidth);
713         double const trim_handle_right = rint(trackview.editor().sample_to_pixel (_region->length()));
714
715         /* Put the fade out handle so that its right side is at the end-of-fade line;
716          */
717         fade_out_handle->set_x0 (handle_right - handle_size);
718         fade_out_handle->set_x1 (handle_right);
719         if (fade_out_trim_handle) {
720                 fade_out_trim_handle->set_x0 (1 + trim_handle_right - handle_size);
721                 fade_out_trim_handle->set_x1 (1 + trim_handle_right);
722         }
723
724         if (fade_out_handle->visible()) {
725                 //see comment for drag_start
726                 entered();
727         }
728         /* don't show shape if its too small */
729
730         if (pwidth < 5) {
731                 hide_end_xfade();
732                 return;
733         }
734
735         if (!trackview.session()->config.get_show_region_fades()) {
736                 hide_end_xfade();
737                 return;
738         }
739
740         double effective_height;
741
742         effective_height = _height;
743
744         if (UIConfiguration::instance().get_show_name_highlight() && effective_height >= NAME_HIGHLIGHT_THRESH) {
745                 effective_height -= NAME_HIGHLIGHT_SIZE;
746         }
747
748         /* points *MUST* be in anti-clockwise order */
749
750         Points points;
751         Points::size_type pi;
752         boost::shared_ptr<const Evoral::ControlList> list (audio_region()->fade_out());
753         Evoral::ControlList::const_iterator x;
754         double length = list->length();
755
756         points.assign (list->size(), Duple());
757
758         for (x = list->begin(), pi = 0; x != list->end(); ++x, ++pi) {
759                 points[pi].x = _pixel_width - pwidth + (pwidth * ((*x)->when/length));
760                 points[pi].y = effective_height - ((*x)->value * (effective_height - 1.));
761         }
762
763         /* draw the line */
764
765         redraw_end_xfade_to (ar, width, points, effective_height, handle_right, pwidth);
766
767         /* ensure trim handle stays on top */
768         if (frame_handle_end) {
769                 frame_handle_end->raise_to_top();
770         }
771 }
772
773 framepos_t
774 AudioRegionView::get_fade_in_shape_width ()
775 {
776         return audio_region()->fade_in()->back()->when;
777 }
778
779 framepos_t
780 AudioRegionView::get_fade_out_shape_width ()
781 {
782         return audio_region()->fade_out()->back()->when;
783 }
784
785
786 void
787 AudioRegionView::redraw_start_xfade ()
788 {
789         boost::shared_ptr<AudioRegion> ar (audio_region());
790
791         if (!ar->fade_in() || ar->fade_in()->empty()) {
792                 return;
793         }
794
795         show_start_xfade();
796         reset_fade_in_shape_width (ar, ar->fade_in()->back()->when);
797 }
798
799 void
800 AudioRegionView::redraw_start_xfade_to (boost::shared_ptr<AudioRegion> ar, framecnt_t /*width*/, Points& points, double effective_height,
801                                         double rect_width)
802 {
803         if (points.size() < 2) {
804                 return;
805         }
806
807         if (!start_xfade_curve) {
808                 start_xfade_curve = new ArdourCanvas::XFadeCurve (group, ArdourCanvas::XFadeCurve::Start);
809                 CANVAS_DEBUG_NAME (start_xfade_curve, string_compose ("xfade start out line for %1", region()->name()));
810                 start_xfade_curve->set_fill_color (UIConfiguration::instance().color_mod ("active crossfade", "crossfade alpha"));
811                 start_xfade_curve->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
812                 start_xfade_curve->set_ignore_events (true);
813         }
814         if (!start_xfade_rect) {
815                 start_xfade_rect = new ArdourCanvas::Rectangle (group);
816                 CANVAS_DEBUG_NAME (start_xfade_rect, string_compose ("xfade start rect for %1", region()->name()));
817                 start_xfade_rect->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
818                 start_xfade_rect->set_fill (false);
819                 start_xfade_rect->set_outline (false);
820                 start_xfade_rect->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_start_xfade_event), start_xfade_rect, this));
821                 start_xfade_rect->set_data ("regionview", this);
822         }
823
824         start_xfade_rect->set (ArdourCanvas::Rect (0.0, 0.0, rect_width, effective_height));
825
826         /* fade out line */
827
828         boost::shared_ptr<AutomationList> inverse = ar->inverse_fade_in ();
829         Points ipoints;
830         Points::size_type npoints;
831
832         if (!inverse) {
833
834                 /* there is no explicit inverse fade in curve, so take the
835                  * regular fade in curve given to use as "points" (already a
836                  * set of coordinates), and convert to the inverse shape.
837                  */
838
839                 npoints = points.size();
840                 ipoints.assign (npoints, Duple());
841
842                 for (Points::size_type i = 0, pci = 0; i < npoints; ++i, ++pci) {
843                         ArdourCanvas::Duple &p (ipoints[pci]);
844                         /* leave x-axis alone but invert with respect to y-axis */
845                         p.y = effective_height - points[pci].y;
846                 }
847
848         } else {
849
850                 /* there is an explicit inverse fade in curve. Grab the points
851                    and convert them into coordinates for the inverse fade in
852                    line.
853                 */
854
855                 npoints = inverse->size();
856                 ipoints.assign (npoints, Duple());
857
858                 Evoral::ControlList::const_iterator x;
859                 Points::size_type pi;
860                 double length = inverse->length();
861
862                 for (x = inverse->begin(), pi = 0; x != inverse->end(); ++x, ++pi) {
863                         ArdourCanvas::Duple& p (ipoints[pi]);
864                         p.x = (rect_width * ((*x)->when/length));
865                         p.y = effective_height - ((*x)->value * (effective_height));
866                 }
867         }
868
869         start_xfade_curve->set_inout (points, ipoints);
870
871         show_start_xfade();
872 }
873
874 void
875 AudioRegionView::redraw_end_xfade ()
876 {
877         boost::shared_ptr<AudioRegion> ar (audio_region());
878
879         if (!ar->fade_out() || ar->fade_out()->empty()) {
880                 return;
881         }
882
883         show_end_xfade();
884
885         reset_fade_out_shape_width (ar, ar->fade_out()->back()->when);
886 }
887
888 void
889 AudioRegionView::redraw_end_xfade_to (boost::shared_ptr<AudioRegion> ar, framecnt_t width, Points& points, double effective_height,
890                                       double rect_edge, double rect_width)
891 {
892         if (points.size() < 2) {
893                 return;
894         }
895
896         if (!end_xfade_curve) {
897                 end_xfade_curve = new ArdourCanvas::XFadeCurve (group, ArdourCanvas::XFadeCurve::End);
898                 CANVAS_DEBUG_NAME (end_xfade_curve, string_compose ("xfade end out line for %1", region()->name()));
899                 end_xfade_curve->set_fill_color (UIConfiguration::instance().color_mod ("active crossfade", "crossfade alpha"));
900                 end_xfade_curve->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
901                 end_xfade_curve->set_ignore_events (true);
902         }
903
904         if (!end_xfade_rect) {
905                 end_xfade_rect = new ArdourCanvas::Rectangle (group);
906                 CANVAS_DEBUG_NAME (end_xfade_rect, string_compose ("xfade end rect for %1", region()->name()));
907                 end_xfade_rect->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
908                 end_xfade_rect->set_fill (false);
909                 end_xfade_rect->set_outline (false);
910                 end_xfade_rect->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_end_xfade_event), end_xfade_rect, this));
911                 end_xfade_rect->set_data ("regionview", this);
912         }
913
914         end_xfade_rect->set (ArdourCanvas::Rect (rect_edge, 0.0, rect_edge + rect_width, effective_height));
915
916         /* fade in line */
917
918         boost::shared_ptr<AutomationList> inverse = ar->inverse_fade_out ();
919         Points ipoints;
920         Points::size_type npoints;
921
922         if (!inverse) {
923
924                 /* there is no explicit inverse fade out curve, so take the
925                  * regular fade out curve given to use as "points" (already a
926                  * set of coordinates), and convert to the inverse shape.
927                  */
928
929                 npoints = points.size();
930                 ipoints.assign (npoints, Duple());
931
932                 Points::size_type pci;
933
934                 for (pci = 0; pci < npoints; ++pci) {
935                         ArdourCanvas::Duple &p (ipoints[pci]);
936                         p.y = effective_height - points[pci].y;
937                 }
938
939         } else {
940
941                 /* there is an explicit inverse fade out curve. Grab the points
942                    and convert them into coordinates for the inverse fade out
943                    line.
944                 */
945
946                 npoints = inverse->size();
947                 ipoints.assign (npoints, Duple());
948
949                 const double rend = trackview.editor().sample_to_pixel (_region->length() - width);
950
951                 Evoral::ControlList::const_iterator x;
952                 Points::size_type pi;
953                 double length = inverse->length();
954
955                 for (x = inverse->begin(), pi = 0; x != inverse->end(); ++x, ++pi) {
956                         ArdourCanvas::Duple& p (ipoints[pi]);
957                         p.x = (rect_width * ((*x)->when/length)) + rend;
958                         p.y = effective_height - ((*x)->value * (effective_height));
959                 }
960         }
961
962         end_xfade_curve->set_inout (ipoints, points);
963
964         show_end_xfade();
965 }
966
967 void
968 AudioRegionView::hide_xfades ()
969 {
970         hide_start_xfade ();
971         hide_end_xfade ();
972 }
973
974 void
975 AudioRegionView::hide_start_xfade ()
976 {
977         if (start_xfade_curve) {
978                 start_xfade_curve->hide();
979         }
980         if (start_xfade_rect) {
981                 start_xfade_rect->hide ();
982         }
983
984         _start_xfade_visible = false;
985 }
986
987 void
988 AudioRegionView::hide_end_xfade ()
989 {
990         if (end_xfade_curve) {
991                 end_xfade_curve->hide();
992         }
993         if (end_xfade_rect) {
994                 end_xfade_rect->hide ();
995         }
996
997         _end_xfade_visible = false;
998 }
999
1000 void
1001 AudioRegionView::show_start_xfade ()
1002 {
1003         if (start_xfade_curve) {
1004                 start_xfade_curve->show();
1005         }
1006         if (start_xfade_rect) {
1007                 start_xfade_rect->show ();
1008         }
1009
1010         _start_xfade_visible = true;
1011 }
1012
1013 void
1014 AudioRegionView::show_end_xfade ()
1015 {
1016         if (end_xfade_curve) {
1017                 end_xfade_curve->show();
1018         }
1019         if (end_xfade_rect) {
1020                 end_xfade_rect->show ();
1021         }
1022
1023         _end_xfade_visible = true;
1024 }
1025
1026 void
1027 AudioRegionView::set_samples_per_pixel (gdouble fpp)
1028 {
1029         RegionView::set_samples_per_pixel (fpp);
1030
1031         if (UIConfiguration::instance().get_show_waveforms ()) {
1032                 for (uint32_t n = 0; n < waves.size(); ++n) {
1033                         waves[n]->set_samples_per_pixel (fpp);
1034                 }
1035         }
1036
1037         if (gain_line) {
1038                 gain_line->reset ();
1039         }
1040
1041         reset_fade_shapes ();
1042 }
1043
1044 void
1045 AudioRegionView::set_amplitude_above_axis (gdouble a)
1046 {
1047         for (uint32_t n=0; n < waves.size(); ++n) {
1048                 waves[n]->set_amplitude_above_axis (a);
1049         }
1050 }
1051
1052 void
1053 AudioRegionView::set_colors ()
1054 {
1055         RegionView::set_colors();
1056
1057         if (gain_line) {
1058                 gain_line->set_line_color (audio_region()->envelope_active() ?
1059                                            UIConfiguration::instance().color ("gain line") :
1060                                            UIConfiguration::instance().color_mod ("gain line inactive", "gain line inactive"));
1061         }
1062
1063         set_waveform_colors ();
1064
1065         if (start_xfade_curve) {
1066                 start_xfade_curve->set_fill_color (UIConfiguration::instance().color_mod ("active crossfade", "crossfade alpha"));
1067                 start_xfade_curve->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
1068         }
1069         if (end_xfade_curve) {
1070                 end_xfade_curve->set_fill_color (UIConfiguration::instance().color_mod ("active crossfade", "crossfade alpha"));
1071                 end_xfade_curve->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
1072         }
1073
1074         if (start_xfade_rect) {
1075                 start_xfade_rect->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
1076         }
1077         if (end_xfade_rect) {
1078                 end_xfade_rect->set_outline_color (UIConfiguration::instance().color ("crossfade line"));
1079         }
1080 }
1081
1082 void
1083 AudioRegionView::setup_waveform_visibility ()
1084 {
1085         if (UIConfiguration::instance().get_show_waveforms ()) {
1086                 for (uint32_t n = 0; n < waves.size(); ++n) {
1087                         /* make sure the zoom level is correct, since we don't update
1088                            this when waveforms are hidden.
1089                         */
1090                         // CAIROCANVAS
1091                         // waves[n]->set_samples_per_pixel (_samples_per_pixel);
1092                         waves[n]->show();
1093                 }
1094         } else {
1095                 for (uint32_t n = 0; n < waves.size(); ++n) {
1096                         waves[n]->hide();
1097                 }
1098         }
1099 }
1100
1101 void
1102 AudioRegionView::temporarily_hide_envelope ()
1103 {
1104         if (gain_line) {
1105                 gain_line->hide ();
1106         }
1107 }
1108
1109 void
1110 AudioRegionView::unhide_envelope ()
1111 {
1112         update_envelope_visibility ();
1113 }
1114
1115 void
1116 AudioRegionView::update_envelope_visibility ()
1117 {
1118         if (!gain_line) {
1119                 return;
1120         }
1121
1122         if (trackview.editor().current_mouse_mode() == Editing::MouseDraw || trackview.editor().current_mouse_mode() == Editing::MouseContent ) {
1123                 gain_line->set_visibility (AutomationLine::VisibleAspects(AutomationLine::ControlPoints|AutomationLine::Line));
1124                 gain_line->canvas_group().raise_to_top ();
1125         } else if (UIConfiguration::instance().get_show_region_gain() || trackview.editor().current_mouse_mode() == Editing::MouseRange ) {
1126                 gain_line->set_visibility (AutomationLine::VisibleAspects(AutomationLine::Line));
1127                 gain_line->canvas_group().raise_to_top ();
1128         } else {
1129                 gain_line->set_visibility (AutomationLine::VisibleAspects(0));
1130         }
1131 }
1132
1133 void
1134 AudioRegionView::delete_waves ()
1135 {
1136         for (vector<ScopedConnection*>::iterator i = _data_ready_connections.begin(); i != _data_ready_connections.end(); ++i) {
1137                 delete *i;
1138         }
1139         _data_ready_connections.clear ();
1140
1141         for (vector<WaveView*>::iterator w = waves.begin(); w != waves.end(); ++w) {
1142                 group->remove(*w);
1143         }
1144         waves.clear();
1145         tmp_waves.clear();
1146         pending_peak_data->show ();
1147 }
1148
1149 void
1150 AudioRegionView::create_waves ()
1151 {
1152         // cerr << "AudioRegionView::create_waves() called on " << this << endl;//DEBUG
1153         RouteTimeAxisView& atv (*(dynamic_cast<RouteTimeAxisView*>(&trackview))); // ick
1154
1155         if (!atv.track()) {
1156                 return;
1157         }
1158
1159         ChanCount nchans = atv.track()->n_channels();
1160
1161         // cerr << "creating waves for " << _region->name() << " with wfd = " << wait_for_data
1162         //              << " and channels = " << nchans.n_audio() << endl;
1163
1164         /* in tmp_waves, set up null pointers for each channel so the vector is allocated */
1165         for (uint32_t n = 0; n < nchans.n_audio(); ++n) {
1166                 tmp_waves.push_back (0);
1167         }
1168
1169         for (vector<ScopedConnection*>::iterator i = _data_ready_connections.begin(); i != _data_ready_connections.end(); ++i) {
1170                 delete *i;
1171         }
1172
1173         _data_ready_connections.clear ();
1174
1175         for (uint32_t i = 0; i < nchans.n_audio(); ++i) {
1176                 _data_ready_connections.push_back (0);
1177         }
1178
1179         for (uint32_t n = 0; n < nchans.n_audio(); ++n) {
1180
1181                 if (n >= audio_region()->n_channels()) {
1182                         break;
1183                 }
1184
1185                 // cerr << "\tchannel " << n << endl;
1186
1187                 if (wait_for_data) {
1188                         if (audio_region()->audio_source(n)->peaks_ready (boost::bind (&AudioRegionView::peaks_ready_handler, this, n), &_data_ready_connections[n], gui_context())) {
1189                                 // cerr << "\tData is ready\n";
1190                                 create_one_wave (n, true);
1191                         } else {
1192                                 // cerr << "\tdata is not ready\n";
1193                                 // we'll get a PeaksReady signal from the source in the future
1194                                 // and will call create_one_wave(n) then.
1195                                 pending_peak_data->show ();
1196                         }
1197
1198                 } else {
1199                         // cerr << "\tdon't delay, display today!\n";
1200                         create_one_wave (n, true);
1201                 }
1202
1203         }
1204 }
1205
1206 void
1207 AudioRegionView::create_one_wave (uint32_t which, bool /*direct*/)
1208 {
1209         //cerr << "AudioRegionView::create_one_wave() called which: " << which << " this: " << this << endl;//DEBUG
1210         RouteTimeAxisView& atv (*(dynamic_cast<RouteTimeAxisView*>(&trackview))); // ick
1211         if (!trackview.session() || trackview.session()->deletion_in_progress () || !atv.track()) {
1212                 /* peaks_ready_handler() may be called from peak_thread_work() while
1213                  * session deletion is in progress.
1214                  * Since session-unload happens in the GUI thread, we need to test
1215                  * in this context.
1216                  */
1217                 return;
1218         }
1219         uint32_t nchans = atv.track()->n_channels().n_audio();
1220         uint32_t n;
1221         uint32_t nwaves = std::min (nchans, audio_region()->n_channels());
1222         gdouble ht;
1223
1224         /* compare to set_height(), use _height as set by streamview (child_height),
1225          * not trackview.current_height() to take stacked layering into acconnt
1226          */
1227         if (!UIConfiguration::instance().get_show_name_highlight() || (_height < NAME_HIGHLIGHT_THRESH)) {
1228                 ht = _height / (double) nchans;
1229         } else {
1230                 ht = (_height - NAME_HIGHLIGHT_SIZE) / (double) nchans;
1231         }
1232
1233         /* first waveview starts at 1.0, not 0.0 since that will overlap the
1234          * frame
1235          */
1236
1237         gdouble yoff = which * ht;
1238
1239         WaveView *wave = new WaveView (group, audio_region ());
1240         CANVAS_DEBUG_NAME (wave, string_compose ("wave view for chn %1 of %2", which, get_item_name()));
1241
1242         wave->set_channel (which);
1243         wave->set_y_position (yoff);
1244         wave->set_height (ht);
1245         wave->set_samples_per_pixel (samples_per_pixel);
1246         wave->set_show_zero_line (true);
1247         wave->set_clip_level (UIConfiguration::instance().get_waveform_clip_level ());
1248         wave->set_start_shift (1.0);
1249
1250         wave->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_wave_view_event), wave, this));
1251
1252         switch (UIConfiguration::instance().get_waveform_shape()) {
1253         case Rectified:
1254                 wave->set_shape (WaveView::Rectified);
1255                 break;
1256         default:
1257                 wave->set_shape (WaveView::Normal);
1258         }
1259
1260         wave->set_logscaled (UIConfiguration::instance().get_waveform_scale() == Logarithmic);
1261
1262         vector<ArdourCanvas::WaveView*> v;
1263         v.push_back (wave);
1264         set_some_waveform_colors (v);
1265
1266         if (!UIConfiguration::instance().get_show_waveforms ()) {
1267                 wave->hide();
1268         }
1269
1270         /* note: calling this function is serialized by the lock
1271            held in the peak building thread that signals that
1272            peaks are ready for use *or* by the fact that it is
1273            called one by one from the GUI thread.
1274         */
1275
1276         if (which < nchans) {
1277                 tmp_waves[which] = wave;
1278         } else {
1279                 /* n-channel track, >n-channel source */
1280         }
1281
1282         /* see if we're all ready */
1283
1284         for (n = 0; n < nchans; ++n) {
1285                 if (tmp_waves[n] == 0) {
1286                         break;
1287                 }
1288         }
1289
1290         if (n == nwaves && waves.empty()) {
1291                 /* all waves are ready */
1292                 tmp_waves.resize(nwaves);
1293
1294                 waves = tmp_waves;
1295                 tmp_waves.clear ();
1296
1297                 /* indicate peak-completed */
1298                 pending_peak_data->hide ();
1299
1300                 /* Restore stacked coverage */
1301                 std::string str = trackview.gui_property ("layer-display");
1302                 if (!str.empty()) {
1303                         LayerDisplay layer_display;
1304                         update_coverage_frames (LayerDisplay (string_2_enum (str, layer_display)));
1305                 }
1306         }
1307
1308         /* channel wave created, don't hook into peaks ready anymore */
1309         delete _data_ready_connections[which];
1310         _data_ready_connections[which] = 0;
1311 }
1312
1313 void
1314 AudioRegionView::peaks_ready_handler (uint32_t which)
1315 {
1316         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&AudioRegionView::create_one_wave, this, which, false));
1317         // cerr << "AudioRegionView::peaks_ready_handler() called on " << which << " this: " << this << endl;
1318 }
1319
1320 void
1321 AudioRegionView::add_gain_point_event (ArdourCanvas::Item *item, GdkEvent *ev, bool with_guard_points)
1322 {
1323         if (!gain_line) {
1324                 return;
1325         }
1326
1327         uint32_t before_p, after_p;
1328         double mx = ev->button.x;
1329         double my = ev->button.y;
1330
1331         item->canvas_to_item (mx, my);
1332
1333         framecnt_t const frame_within_region = (framecnt_t) floor (mx * samples_per_pixel);
1334
1335         if (!gain_line->control_points_adjacent (frame_within_region, before_p, after_p)) {
1336                 /* no adjacent points */
1337                 return;
1338         }
1339
1340         /*y is in item frame */
1341         double const bx = gain_line->nth (before_p)->get_x();
1342         double const ax = gain_line->nth (after_p)->get_x();
1343         double const click_ratio = (ax - mx) / (ax - bx);
1344
1345         double y = ((gain_line->nth (before_p)->get_y() * click_ratio) + (gain_line->nth (after_p)->get_y() * (1 - click_ratio)));
1346
1347         /* don't create points that can't be seen */
1348
1349         update_envelope_visibility ();
1350         framepos_t rpos = region ()->position ();
1351         MusicFrame snap_pos (trackview.editor().pixel_to_sample (mx) + rpos, 0);
1352         trackview.editor ().snap_to_with_modifier (snap_pos, ev);
1353         framepos_t fx = snap_pos.frame - rpos;
1354
1355         if (fx > _region->length()) {
1356                 return;
1357         }
1358
1359         /* compute vertical fractional position */
1360
1361         y = 1.0 - (y / (gain_line->height()));
1362
1363         /* map using gain line */
1364
1365         gain_line->view_to_model_coord (mx, y);
1366
1367         /* XXX STATEFUL: can't convert to stateful diff until we
1368            can represent automation data with it.
1369         */
1370
1371         XMLNode &before = audio_region()->envelope()->get_state();
1372         MementoCommand<AudioRegion>* region_memento = 0;
1373
1374         if (!audio_region()->envelope_active()) {
1375                 XMLNode &region_before = audio_region()->get_state();
1376                 audio_region()->set_envelope_active(true);
1377                 XMLNode &region_after = audio_region()->get_state();
1378                 region_memento = new MementoCommand<AudioRegion>(*(audio_region().get()), &region_before, &region_after);
1379         }
1380
1381         if (audio_region()->envelope()->editor_add (fx, y, with_guard_points)) {
1382                 XMLNode &after = audio_region()->envelope()->get_state();
1383                 std::list<Selectable*> results;
1384
1385                 trackview.editor().begin_reversible_command (_("add gain control point"));
1386
1387                 if (region_memento) {
1388                         trackview.session()->add_command (region_memento);
1389                 }
1390
1391                 trackview.session()->add_command (new MementoCommand<AutomationList>(*audio_region()->envelope().get(), &before, &after));
1392
1393                 gain_line->get_selectables (fx + region ()->position (), fx + region ()->position (), 0.0, 1.0, results);
1394                 trackview.editor ().get_selection ().set (results);
1395
1396                 trackview.editor ().commit_reversible_command ();
1397                 trackview.session ()->set_dirty ();
1398         }
1399 }
1400
1401 void
1402 AudioRegionView::remove_gain_point_event (ArdourCanvas::Item *item, GdkEvent* /*ev*/)
1403 {
1404         ControlPoint *cp = reinterpret_cast<ControlPoint *> (item->get_data ("control_point"));
1405         audio_region()->envelope()->erase (cp->model());
1406 }
1407
1408 GhostRegion*
1409 AudioRegionView::add_ghost (TimeAxisView& tv)
1410 {
1411         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(&trackview);
1412
1413         if (!rtv) {
1414                 return 0;
1415         }
1416
1417         double unit_position = _region->position () / samples_per_pixel;
1418         AudioGhostRegion* ghost = new AudioGhostRegion (*this, tv, trackview, unit_position);
1419         uint32_t nchans;
1420
1421         nchans = rtv->track()->n_channels().n_audio();
1422
1423         for (uint32_t n = 0; n < nchans; ++n) {
1424
1425                 if (n >= audio_region()->n_channels()) {
1426                         break;
1427                 }
1428
1429                 WaveView *wave = new WaveView (ghost->group, audio_region());
1430                 CANVAS_DEBUG_NAME (wave, string_compose ("ghost wave for %1", get_item_name()));
1431
1432                 wave->set_channel (n);
1433                 wave->set_samples_per_pixel (samples_per_pixel);
1434                 wave->set_amplitude_above_axis (_amplitude_above_axis);
1435
1436                 ghost->waves.push_back(wave);
1437         }
1438
1439         ghost->set_height ();
1440         ghost->set_duration (_region->length() / samples_per_pixel);
1441         ghost->set_colors();
1442         ghosts.push_back (ghost);
1443
1444         return ghost;
1445 }
1446
1447 void
1448 AudioRegionView::entered ()
1449 {
1450         trackview.editor().set_current_trimmable (_region);
1451         trackview.editor().set_current_movable (_region);
1452
1453         update_envelope_visibility();
1454
1455         if ((trackview.editor().current_mouse_mode() == Editing::MouseObject)) {
1456                 if (start_xfade_rect) {
1457                         start_xfade_rect->set_outline (true);
1458                 }
1459                 if (end_xfade_rect) {
1460                         end_xfade_rect->set_outline (true);
1461                 }
1462                 if (fade_in_handle) {
1463                         fade_in_handle->show ();
1464                         fade_in_handle->raise_to_top ();
1465                 }
1466                 if (fade_out_handle) {
1467                         fade_out_handle->show ();
1468                         fade_out_handle->raise_to_top ();
1469                 }
1470                 if (fade_in_trim_handle) {
1471                         boost::shared_ptr<AudioRegion> ar (audio_region());
1472                         if (!ar->locked() && (ar->fade_in()->back()->when > 64 || (ar->can_trim() & Trimmable::FrontTrimEarlier))) {
1473                                 fade_in_trim_handle->show ();
1474                                 fade_in_trim_handle->raise_to_top ();
1475                         } else {
1476                                 fade_in_trim_handle->hide ();
1477                         }
1478                 }
1479                 if (fade_out_trim_handle) {
1480                         boost::shared_ptr<AudioRegion> ar (audio_region());
1481                         if (!ar->locked() && (ar->fade_out()->back()->when > 64 || (ar->can_trim() & Trimmable::EndTrimLater))) {
1482                                 fade_out_trim_handle->show ();
1483                                 fade_out_trim_handle->raise_to_top ();
1484                         } else {
1485                                 fade_out_trim_handle->hide ();
1486                         }
1487                 }
1488         } else {  //this happens when we switch tools; if we switch away from Grab mode,  hide all the fade handles
1489                 if (fade_in_handle)       { fade_in_handle->hide(); }
1490                 if (fade_out_handle)      { fade_out_handle->hide(); }
1491                 if (fade_in_trim_handle)  { fade_in_trim_handle->hide(); }
1492                 if (fade_out_trim_handle) { fade_out_trim_handle->hide(); }
1493                 if (start_xfade_rect)     { start_xfade_rect->set_outline (false); }
1494                 if (end_xfade_rect)       { end_xfade_rect->set_outline (false); }
1495         }
1496 }
1497
1498 void
1499 AudioRegionView::exited ()
1500 {
1501         trackview.editor().set_current_trimmable (boost::shared_ptr<Trimmable>());
1502         trackview.editor().set_current_movable (boost::shared_ptr<Movable>());
1503
1504 //      if (gain_line) {
1505 //              gain_line->remove_visibility (AutomationLine::ControlPoints);
1506 //      }
1507
1508         if (fade_in_handle)       { fade_in_handle->hide(); }
1509         if (fade_out_handle)      { fade_out_handle->hide(); }
1510         if (fade_in_trim_handle)  { fade_in_trim_handle->hide(); }
1511         if (fade_out_trim_handle) { fade_out_trim_handle->hide(); }
1512         if (start_xfade_rect)     { start_xfade_rect->set_outline (false); }
1513         if (end_xfade_rect)       { end_xfade_rect->set_outline (false); }
1514 }
1515
1516 void
1517 AudioRegionView::envelope_active_changed ()
1518 {
1519         if (gain_line) {
1520                 gain_line->set_line_color (audio_region()->envelope_active() ?
1521                                            UIConfiguration::instance().color ("gain line") :
1522                                            UIConfiguration::instance().color_mod ("gain line inactive", "gain line inactive"));
1523                 update_envelope_visibility ();
1524         }
1525 }
1526
1527 void
1528 AudioRegionView::color_handler ()
1529 {
1530         //case cMutedWaveForm:
1531         //case cWaveForm:
1532         //case cWaveFormClip:
1533         //case cZeroLine:
1534         set_colors ();
1535
1536         //case cGainLineInactive:
1537         //case cGainLine:
1538         envelope_active_changed();
1539
1540 }
1541
1542 void
1543 AudioRegionView::set_waveform_colors ()
1544 {
1545         set_some_waveform_colors (waves);
1546 }
1547
1548 void
1549 AudioRegionView::set_some_waveform_colors (vector<ArdourCanvas::WaveView*>& waves_to_color)
1550 {
1551         ArdourCanvas::Color fill;
1552         ArdourCanvas::Color outline;
1553         ArdourCanvas::Color clip = UIConfiguration::instance().color ("clipped waveform");
1554         ArdourCanvas::Color zero = UIConfiguration::instance().color ("zero line");
1555
1556         if (_selected) {
1557                 if (_region->muted()) {
1558                         /* hide outline with zero alpha */
1559                         outline = UINT_RGBA_CHANGE_A(UIConfiguration::instance().color ("selected waveform outline"), 0);
1560                         fill = UINT_RGBA_CHANGE_A(UIConfiguration::instance().color ("selected waveform fill"), MUTED_ALPHA);
1561                 } else {
1562                         outline = UIConfiguration::instance().color ("selected waveform outline");
1563                         fill = UIConfiguration::instance().color ("selected waveform fill");
1564                 }
1565         } else {
1566                 if (_recregion) {
1567                         outline = UIConfiguration::instance().color ("recording waveform outline");
1568                         fill = UIConfiguration::instance().color ("recording waveform fill");
1569                 } else {
1570                         if (_region->muted()) {
1571                                 /* hide outline with zero alpha */
1572                                 outline = UINT_RGBA_CHANGE_A(UIConfiguration::instance().color ("waveform outline"), 0);
1573                                 fill = UINT_RGBA_CHANGE_A(UIConfiguration::instance().color ("waveform fill"), MUTED_ALPHA);
1574                         } else {
1575                                 outline = UIConfiguration::instance().color ("waveform outline");
1576                                 fill = UIConfiguration::instance().color ("waveform fill");
1577                         }
1578                 }
1579         }
1580
1581         for (vector<ArdourCanvas::WaveView*>::iterator w = waves_to_color.begin(); w != waves_to_color.end(); ++w) {
1582                 (*w)->set_fill_color (fill);
1583                 (*w)->set_outline_color (outline);
1584                 (*w)->set_clip_color (clip);
1585                 (*w)->set_zero_color (zero);
1586         }
1587 }
1588
1589 void
1590 AudioRegionView::set_frame_color ()
1591 {
1592         if (!frame) {
1593                 return;
1594         }
1595
1596         RegionView::set_frame_color ();
1597
1598         set_waveform_colors ();
1599 }
1600
1601 void
1602 AudioRegionView::set_fade_visibility (bool yn)
1603 {
1604         if (yn) {
1605                 if (start_xfade_curve)    { start_xfade_curve->show (); }
1606                 if (end_xfade_curve)      { end_xfade_curve->show (); }
1607                 if (start_xfade_rect)     { start_xfade_rect->show (); }
1608                 if (end_xfade_rect)       { end_xfade_rect->show (); }
1609                 } else {
1610                 if (start_xfade_curve)    { start_xfade_curve->hide(); }
1611                 if (end_xfade_curve)      { end_xfade_curve->hide(); }
1612                 if (fade_in_handle)       { fade_in_handle->hide(); }
1613                 if (fade_out_handle)      { fade_out_handle->hide(); }
1614                 if (fade_in_trim_handle)  { fade_in_trim_handle->hide(); }
1615                 if (fade_out_trim_handle) { fade_out_trim_handle->hide(); }
1616                 if (start_xfade_rect)     { start_xfade_rect->hide (); }
1617                 if (end_xfade_rect)       { end_xfade_rect->hide (); }
1618                 if (start_xfade_rect)     { start_xfade_rect->set_outline (false); }
1619                 if (end_xfade_rect)       { end_xfade_rect->set_outline (false); }
1620         }
1621 }
1622
1623 void
1624 AudioRegionView::update_coverage_frames (LayerDisplay d)
1625 {
1626         RegionView::update_coverage_frames (d);
1627
1628         if (d == Stacked) {
1629                 if (fade_in_handle)       { fade_in_handle->raise_to_top (); }
1630                 if (fade_out_handle)      { fade_out_handle->raise_to_top (); }
1631                 if (fade_in_trim_handle)  { fade_in_trim_handle->raise_to_top (); }
1632                 if (fade_out_trim_handle) { fade_out_trim_handle->raise_to_top (); }
1633         }
1634 }
1635
1636 void
1637 AudioRegionView::show_region_editor ()
1638 {
1639         if (editor == 0) {
1640                 editor = new AudioRegionEditor (trackview.session(), audio_region());
1641         }
1642
1643         editor->present ();
1644         editor->show_all();
1645 }
1646
1647 void
1648 AudioRegionView::transients_changed ()
1649 {
1650         AnalysisFeatureList analysis_features;
1651         _region->transients (analysis_features);
1652         framepos_t position = _region->position();
1653         framepos_t first = _region->first_frame();
1654         framepos_t last = _region->last_frame();
1655
1656         double y1;
1657         if (_height >= NAME_HIGHLIGHT_THRESH) {
1658                 y1 = _height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 1;
1659         } else {
1660                 y1 = _height - 1;
1661         }
1662
1663         while (feature_lines.size() < analysis_features.size()) {
1664                 ArdourCanvas::Line* canvas_item = new ArdourCanvas::Line(group);
1665                 CANVAS_DEBUG_NAME (canvas_item, string_compose ("transient group for %1", region()->name()));
1666                 canvas_item->set_outline_color (UIConfiguration::instance().color ("zero line")); // also in Editor::leave_handler()
1667
1668                 canvas_item->set (ArdourCanvas::Duple (-1.0, 2.0),
1669                                   ArdourCanvas::Duple (1.0, y1));
1670
1671                 canvas_item->raise_to_top ();
1672                 canvas_item->show ();
1673
1674                 canvas_item->set_data ("regionview", this);
1675                 canvas_item->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_feature_line_event), canvas_item, this));
1676
1677                 feature_lines.push_back (make_pair(0, canvas_item));
1678         }
1679
1680         while (feature_lines.size() > analysis_features.size()) {
1681                 ArdourCanvas::Line* line = feature_lines.back().second;
1682                 feature_lines.pop_back ();
1683                 delete line;
1684         }
1685
1686         AnalysisFeatureList::const_iterator i;
1687         list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
1688
1689         for (i = analysis_features.begin(), l = feature_lines.begin(); i != analysis_features.end() && l != feature_lines.end(); ++i, ++l) {
1690
1691                 float *pos = new float;
1692                 *pos = trackview.editor().sample_to_pixel (*i - position);
1693
1694                 (*l).second->set (
1695                         ArdourCanvas::Duple (*pos, 2.0),
1696                         ArdourCanvas::Duple (*pos, y1)
1697                         );
1698
1699                 (*l).second->set_data ("position", pos); // is this *modified* (drag?), if not use *i
1700                 (*l).first = *i;
1701
1702                 if (l->first < first || l->first >= last) {
1703                         l->second->hide();
1704                 } else {
1705                         l->second->show();
1706                 }
1707         }
1708 }
1709
1710 void
1711 AudioRegionView::update_transient(float /*old_pos*/, float new_pos)
1712 {
1713         /* Find frame at old pos, calulate new frame then update region transients*/
1714         list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
1715
1716         for (l = feature_lines.begin(); l != feature_lines.end(); ++l) {
1717
1718                 /* Line has been updated in drag so we compare to new_pos */
1719
1720                 float* pos = (float*) (*l).second->get_data ("position");
1721
1722                 if (rint(new_pos) == rint(*pos)) {
1723                                 framepos_t position = _region->position();
1724                     framepos_t old_frame = (*l).first;
1725                     framepos_t new_frame = trackview.editor().pixel_to_sample (new_pos) + position;
1726                     _region->update_transient (old_frame, new_frame);
1727                     break;
1728                 }
1729         }
1730 }
1731
1732 void
1733 AudioRegionView::remove_transient (float pos)
1734 {
1735         /* this is called from Editor::remove_transient () with pos == get_data ("position")
1736          * which is the item's x-coordinate inside the ARV.
1737          *
1738          * Find frame at old pos, calulate new frame then update region transients
1739          */
1740         list<std::pair<framepos_t, ArdourCanvas::Line*> >::iterator l;
1741
1742         for (l = feature_lines.begin(); l != feature_lines.end(); ++l) {
1743                 float *line_pos = (float*) (*l).second->get_data ("position");
1744                 if (rint(pos) == rint(*line_pos)) {
1745                     _region->remove_transient ((*l).first);
1746                     break;
1747                 }
1748         }
1749 }
1750
1751 void
1752 AudioRegionView::thaw_after_trim ()
1753 {
1754         RegionView::thaw_after_trim ();
1755         unhide_envelope ();
1756         drag_end ();
1757 }
1758
1759
1760 void
1761 AudioRegionView::show_xfades ()
1762 {
1763         show_start_xfade ();
1764         show_end_xfade ();
1765 }
1766
1767 void
1768 AudioRegionView::drag_start ()
1769 {
1770         TimeAxisViewItem::drag_start ();
1771
1772         //we used to hide xfades here.  I don't see the point with the new model, but we can re-implement if needed
1773 }
1774
1775 void
1776 AudioRegionView::drag_end ()
1777 {
1778         TimeAxisViewItem::drag_end ();
1779         //see comment for drag_start
1780
1781         if (fade_in_handle && fade_in_handle->visible()) {
1782                 // lenght of region or fade changed, re-check
1783                 // if fade_in_trim_handle or fade_out_trim_handle should
1784                 // be visible. -- If the fade_in_handle is visible
1785                 // we have focus and are not in internal edit mode.
1786                 entered();
1787         }
1788 }
1789
1790 void
1791 AudioRegionView::parameter_changed (string const & p)
1792 {
1793         if (p == "show-waveforms") {
1794                 setup_waveform_visibility ();
1795         }
1796 }