libs/canvas/wave_view.cc

   1 /*
   2     Copyright (C) 2011-2013 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <cmath>
  22 #include <cairomm/cairomm.h>
  23
  24 #include "gtkmm2ext/utils.h"
  25
  26 #include "pbd/compose.h"
  27 #include "pbd/signals.h"
  28 #include "pbd/stacktrace.h"
  29
  30 #include "ardour/types.h"
  31 #include "ardour/dB.h"
  32 #include "ardour/audioregion.h"
  33
  34 #include "canvas/wave_view.h"
  35 #include "canvas/utils.h"
  36 #include "canvas/canvas.h"
  37 #include "canvas/colors.h"
  38
  39 #include <gdkmm/general.h>
  40
  41 using namespace std;
  42 using namespace ARDOUR;
  43 using namespace ArdourCanvas;
  44
  45 #define CACHE_HIGH_WATER (2)
  46
  47 std::map <boost::shared_ptr<AudioSource>, std::vector<WaveView::CacheEntry> >  WaveView::_image_cache;
  48 double WaveView::_global_gradient_depth = 0.6;
  49 bool WaveView::_global_logscaled = false;
  50 WaveView::Shape WaveView::_global_shape = WaveView::Normal;
  51 bool WaveView::_global_show_waveform_clipping = true;
  52 double WaveView::_clip_level = 0.98853;
  53
  54 PBD::Signal0<void> WaveView::VisualPropertiesChanged;
  55 PBD::Signal0<void> WaveView::ClipLevelChanged;
  56
  57 WaveView::WaveView (Canvas* c, boost::shared_ptr<ARDOUR::AudioRegion> region)
  58         : Item (c)
  59         , _region (region)
  60         , _channel (0)
  61         , _samples_per_pixel (0)
  62         , _height (64)
  63         , _show_zero (false)
  64         , _zero_color (0xff0000ff)
  65         , _clip_color (0xff0000ff)
  66         , _logscaled (_global_logscaled)
  67         , _shape (_global_shape)
  68         , _gradient_depth (_global_gradient_depth)
  69         , _shape_independent (false)
  70         , _logscaled_independent (false)
  71         , _gradient_depth_independent (false)
  72         , _amplitude_above_axis (1.0)
  73         , _region_amplitude (_region->scale_amplitude ())
  74         , _start_shift (0.0)
  75         , _region_start (region->start())
  76 {
  77         VisualPropertiesChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_visual_property_change, this));
  78         ClipLevelChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_clip_level_change, this));
  79 }
  80
  81 WaveView::WaveView (Item* parent, boost::shared_ptr<ARDOUR::AudioRegion> region)
  82         : Item (parent)
  83         , _region (region)
  84         , _channel (0)
  85         , _samples_per_pixel (0)
  86         , _height (64)
  87         , _show_zero (false)
  88         , _zero_color (0xff0000ff)
  89         , _clip_color (0xff0000ff)
  90         , _logscaled (_global_logscaled)
  91         , _shape (_global_shape)
  92         , _gradient_depth (_global_gradient_depth)
  93         , _shape_independent (false)
  94         , _logscaled_independent (false)
  95         , _gradient_depth_independent (false)
  96         , _amplitude_above_axis (1.0)
  97         , _region_amplitude (_region->scale_amplitude ())
  98         , _region_start (region->start())
  99 {
 100         VisualPropertiesChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_visual_property_change, this));
 101         ClipLevelChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_clip_level_change, this));
 102 }
 103
 104 WaveView::~WaveView ()
 105 {
 106         invalidate_image_cache ();
 107 }
 108
 109 void
 110 WaveView::handle_visual_property_change ()
 111 {
 112         bool changed = false;
 113
 114         if (!_shape_independent && (_shape != global_shape())) {
 115                 _shape = global_shape();
 116                 changed = true;
 117         }
 118
 119         if (!_logscaled_independent && (_logscaled != global_logscaled())) {
 120                 _logscaled = global_logscaled();
 121                 changed = true;
 122         }
 123
 124         if (!_gradient_depth_independent && (_gradient_depth != global_gradient_depth())) {
 125                 _gradient_depth = global_gradient_depth();
 126                 changed = true;
 127         }
 128
 129         if (changed) {
 130                 begin_visual_change ();
 131                 invalidate_image_cache ();
 132                 end_visual_change ();
 133         }
 134 }
 135
 136 void
 137 WaveView::handle_clip_level_change ()
 138 {
 139         begin_visual_change ();
 140         invalidate_image_cache ();
 141         end_visual_change ();
 142 }
 143
 144 void
 145 WaveView::set_fill_color (Color c)
 146 {
 147         if (c != _fill_color) {
 148                 begin_visual_change ();
 149                 invalidate_image_cache ();
 150                 Fill::set_fill_color (c);
 151                 end_visual_change ();
 152         }
 153 }
 154
 155 void
 156 WaveView::set_outline_color (Color c)
 157 {
 158         if (c != _outline_color) {
 159                 begin_visual_change ();
 160                 invalidate_image_cache ();
 161                 Outline::set_outline_color (c);
 162                 end_visual_change ();
 163         }
 164 }
 165
 166 void
 167 WaveView::set_samples_per_pixel (double samples_per_pixel)
 168 {
 169         if (samples_per_pixel != _samples_per_pixel) {
 170                 begin_change ();
 171
 172                 invalidate_image_cache ();
 173                 _samples_per_pixel = samples_per_pixel;
 174                 _bounding_box_dirty = true;
 175
 176                 end_change ();
 177         }
 178 }
 179
 180 static inline double
 181 window_to_image (double wave_origin, double image_start)
 182 {
 183         return image_start - wave_origin;
 184 }
 185
 186 static inline float
 187 _log_meter (float power, double lower_db, double upper_db, double non_linearity)
 188 {
 189         return (power < lower_db ? 0.0 : pow((power-lower_db)/(upper_db-lower_db), non_linearity));
 190 }
 191
 192 static inline float
 193 alt_log_meter (float power)
 194 {
 195         return _log_meter (power, -192.0, 0.0, 8.0);
 196 }
 197
 198 void
 199 WaveView::set_clip_level (double dB)
 200 {
 201         const double clip_level = dB_to_coefficient (dB);
 202         if (clip_level != _clip_level) {
 203                 _clip_level = clip_level;
 204                 ClipLevelChanged ();
 205         }
 206 }
 207
 208 void
 209 WaveView::invalidate_image_cache ()
 210 {
 211         vector <uint32_t> deletion_list;
 212         vector <CacheEntry> caches;
 213
 214         if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
 215                 caches = _image_cache.find (_region->audio_source ())->second;
 216         } else {
 217                 return;
 218         }
 219
 220         for (uint32_t i = 0; i < caches.size (); ++i) {
 221
 222                 if (_channel != caches[i].channel
 223                     || _height != caches[i].height
 224                     || _region_amplitude != caches[i].amplitude
 225                     || _fill_color != caches[i].fill_color) {
 226
 227                         continue;
 228                 }
 229
 230                 deletion_list.push_back (i);
 231
 232         }
 233
 234         while (deletion_list.size() > 0) {
 235                 caches[deletion_list.back ()].image.clear ();
 236                 caches.erase (caches.begin() + deletion_list.back());
 237                 deletion_list.pop_back();
 238         }
 239
 240         if (caches.size () == 0) {
 241                 _image_cache.erase(_region->audio_source ());
 242         } else {
 243                 _image_cache[_region->audio_source ()] = caches;
 244         }
 245
 246 }
 247
 248 void
 249 WaveView::consolidate_image_cache () const
 250 {
 251         list <uint32_t> deletion_list;
 252         vector <CacheEntry> caches;
 253         uint32_t other_entries = 0;
 254
 255         if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
 256                 caches  = _image_cache.find (_region->audio_source ())->second;
 257         }
 258
 259         for (uint32_t i = 0; i < caches.size (); ++i) {
 260
 261                 if (_channel != caches[i].channel
 262                     || _height != caches[i].height
 263                     || _region_amplitude != caches[i].amplitude
 264                     || _fill_color != caches[i].fill_color) {
 265
 266                         other_entries++;
 267                         continue;
 268                 }
 269
 270                 framepos_t segment_start = caches[i].start;
 271                 framepos_t segment_end = caches[i].end;
 272
 273                 for (uint32_t j = i; j < caches.size (); ++j) {
 274
 275                         if (i == j || _channel != caches[j].channel
 276                             || _height != caches[i].height
 277                             || _region_amplitude != caches[i].amplitude
 278                             || _fill_color != caches[i].fill_color) {
 279
 280                                 continue;
 281                         }
 282
 283                         if (caches[j].start >= segment_start && caches[j].end <= segment_end) {
 284
 285                                 deletion_list.push_back (j);
 286                         }
 287                 }
 288         }
 289
 290         deletion_list.sort ();
 291         deletion_list.unique ();
 292
 293         while (deletion_list.size() > 0) {
 294                 caches[deletion_list.back ()].image.clear ();
 295                 caches.erase (caches.begin() + deletion_list.back ());
 296                 deletion_list.pop_back();
 297         }
 298
 299         /* We don't care if this channel/height/amplitude has anything in the cache - just drop the Last Added entries
 300            until we reach a size where there is a maximum of CACHE_HIGH_WATER + other entries.
 301         */
 302
 303         while (caches.size() > CACHE_HIGH_WATER + other_entries) {
 304                 caches.front ().image.clear ();
 305                 caches.erase(caches.begin ());
 306         }
 307
 308         if (caches.size () == 0) {
 309                 _image_cache.erase (_region->audio_source ());
 310         } else {
 311                 _image_cache[_region->audio_source ()] = caches;
 312         }
 313 }
 314
 315 Coord
 316 WaveView::y_extent (double s, bool /*round_to_lower_edge*/) const
 317 {
 318         /* it is important that this returns an integral value, so that we
 319          * can ensure correct single pixel behaviour.
 320          *
 321          * we need (_height - max(wave_line_width))
 322          * wave_line_width == 1 IFF top==bottom (1 sample per pixel or flat line)
 323          * wave_line_width == 2 otherwise
 324          * then round away from the zero line, towards peak
 325          */
 326         if (_shape == Rectified) {
 327                 // we only ever have 1 point and align to the bottom (not center)
 328                 return floor ((1.0 - s) * (_height - 2.0));
 329         } else {
 330                 /* currently canvas rectangle is off-by-one and we
 331                  * cannot draw a pixel at 0 (-.5 .. +.5) without it being
 332                  * clipped. A value 1.0 (ideally one point at y=0) ends
 333                  * up a pixel down. and a value of -1.0 (ideally y = _height-1)
 334                  * currently is on the bottom separator line :(
 335                  * So to make the complete waveform appear centered in
 336                  * a region, we translate by +.5 (instead of -.5)
 337                  * and waste two pixel of height: -4 (instad of -2)
 338                  *
 339                  * This needs fixing in canvas/rectangle the intersect
 340                  * functions and probably a couple of other places as well...
 341                  */
 342                 Coord pos;
 343                 if (s < 0) {
 344                         pos = ceil  ((1.0 - s) * .5 * (_height - 4.0));
 345                 } else {
 346                         pos = floor ((1.0 - s) * .5 * (_height - 4.0));
 347                 }
 348                 return min (_height - 4.0, (max (0.0, pos)));
 349         }
 350 }
 351
 352 struct LineTips {
 353         double top;
 354         double bot;
 355         double spread;
 356         bool clip_max;
 357         bool clip_min;
 358
 359         LineTips() : top (0.0), bot (0.0), clip_max (false), clip_min (false) {}
 360 };
 361
 362 struct ImageSet {
 363         Cairo::RefPtr<Cairo::ImageSurface> wave;
 364         Cairo::RefPtr<Cairo::ImageSurface> outline;
 365         Cairo::RefPtr<Cairo::ImageSurface> clip;
 366         Cairo::RefPtr<Cairo::ImageSurface> zero;
 367
 368         ImageSet() :
 369                 wave (0), outline (0), clip (0), zero (0) {}
 370 };
 371
 372 void
 373 WaveView::draw_image (Cairo::RefPtr<Cairo::ImageSurface>& image, PeakData* _peaks, int n_peaks) const
 374 {
 375
 376         ImageSet images;
 377
 378         images.wave = Cairo::ImageSurface::create (Cairo::FORMAT_A8, n_peaks, _height);
 379         images.outline = Cairo::ImageSurface::create (Cairo::FORMAT_A8, n_peaks, _height);
 380         images.clip = Cairo::ImageSurface::create (Cairo::FORMAT_A8, n_peaks, _height);
 381         images.zero = Cairo::ImageSurface::create (Cairo::FORMAT_A8, n_peaks, _height);
 382
 383         Cairo::RefPtr<Cairo::Context> wave_context = Cairo::Context::create (images.wave);
 384         Cairo::RefPtr<Cairo::Context> outline_context = Cairo::Context::create (images.outline);
 385         Cairo::RefPtr<Cairo::Context> clip_context = Cairo::Context::create (images.clip);
 386         Cairo::RefPtr<Cairo::Context> zero_context = Cairo::Context::create (images.zero);
 387
 388         boost::scoped_array<LineTips> tips (new LineTips[n_peaks]);
 389
 390         /* Clip level nominally set to -0.9dBFS to account for inter-sample
 391            interpolation possibly clipping (value may be too low).
 392
 393            We adjust by the region's own gain (but note: not by any gain
 394            automation or its gain envelope) so that clip indicators are closer
 395            to providing data about on-disk data. This multiplication is
 396            needed because the data we get from AudioRegion::read_peaks()
 397            has been scaled by scale_amplitude() already.
 398         */
 399
 400         const double clip_level = _clip_level * _region_amplitude;
 401
 402         if (_shape == WaveView::Rectified) {
 403
 404                 /* each peak is a line from the bottom of the waveview
 405                  * to a point determined by max (_peaks[i].max,
 406                  * _peaks[i].min)
 407                  */
 408
 409                 if (_logscaled) {
 410                         for (int i = 0; i < n_peaks; ++i) {
 411
 412                                 tips[i].bot = height() - 1.0;
 413                                 const double p = alt_log_meter (fast_coefficient_to_dB (max (fabs (_peaks[i].max), fabs (_peaks[i].min))));
 414                                 tips[i].top = y_extent (p, false);
 415                                 tips[i].spread = p * (_height - 1.0);
 416
 417                                 if (fabs (_peaks[i].max) >= clip_level) {
 418                                         tips[i].clip_max = true;
 419                                 }
 420
 421                                 if (fabs (_peaks[i].min) >= clip_level) {
 422                                         tips[i].clip_max = true;
 423                                 }
 424                         }
 425
 426                 } else {for (int i = 0; i < n_peaks; ++i) {
 427
 428                                 tips[i].bot = height() - 1.0;
 429                                 const double p = max(fabs (_peaks[i].max), fabs (_peaks[i].min));
 430                                 tips[i].top = y_extent (p, false);
 431                                 tips[i].spread = p * (_height - 2.0);
 432                                 if (p >= clip_level) {
 433                                         tips[i].clip_max = true;
 434                                 }
 435                         }
 436
 437                 }
 438
 439         } else {
 440
 441                 if (_logscaled) {
 442                         for (int i = 0; i < n_peaks; ++i) {
 443                                 double top = _peaks[i].max;
 444                                 double bot = _peaks[i].min;
 445
 446                                 if (_peaks[i].max > 0 && _peaks[i].min > 0) {
 447                                         if (fabs (_peaks[i].max) >= clip_level) {
 448                                                 tips[i].clip_max = true;
 449                                         }
 450                                 }
 451                                 else if (_peaks[i].max < 0 && _peaks[i].min < 0) {
 452                                         if (fabs (_peaks[i].min) >= clip_level) {
 453                                                 tips[i].clip_min = true;
 454                                         }
 455                                 } else {
 456                                         if (fabs (_peaks[i].max) >= clip_level) {
 457                                                 tips[i].clip_max = true;
 458                                         }
 459                                         if (fabs (_peaks[i].min) >= clip_level) {
 460                                                 tips[i].clip_min = true;
 461                                         }
 462                                 }
 463
 464                                 if (top > 0.0) {
 465                                         top = alt_log_meter (fast_coefficient_to_dB (top));
 466                                 } else if (top < 0.0) {
 467                                         top =-alt_log_meter (fast_coefficient_to_dB (-top));
 468                                 } else {
 469                                         top = 0.0;
 470                                 }
 471
 472                                 if (bot > 0.0) {
 473                                         bot = alt_log_meter (fast_coefficient_to_dB (bot));
 474                                 } else if (bot < 0.0) {
 475                                         bot = -alt_log_meter (fast_coefficient_to_dB (-bot));
 476                                 } else {
 477                                         bot = 0.0;
 478                                 }
 479
 480                                 tips[i].top = y_extent (top, false);
 481                                 tips[i].bot = y_extent (bot, true);
 482                                 tips[i].spread = fabs (tips[i].top - tips[i].bot);
 483                         }
 484
 485                 } else {
 486                         for (int i = 0; i < n_peaks; ++i) {
 487                                 if (_peaks[i].max > 0 && _peaks[i].min > 0) {
 488                                         if (fabs (_peaks[i].max) >= clip_level) {
 489                                                 tips[i].clip_max = true;
 490                                         }
 491                                 }
 492                                 else if (_peaks[i].max < 0 && _peaks[i].min < 0) {
 493                                         if (fabs (_peaks[i].min) >= clip_level) {
 494                                                 tips[i].clip_min = true;
 495                                         }
 496                                 } else {
 497                                         if (fabs (_peaks[i].max) >= clip_level) {
 498                                                 tips[i].clip_max = true;
 499                                         }
 500                                         if (fabs (_peaks[i].min) >= clip_level) {
 501                                                 tips[i].clip_min = true;
 502                                         }
 503                                 }
 504
 505                                 tips[i].top = y_extent (_peaks[i].max, false);
 506                                 tips[i].bot = y_extent (_peaks[i].min, true);
 507                                 tips[i].spread = fabs (tips[i].top - tips[i].bot);
 508                         }
 509
 510                 }
 511         }
 512         Color alpha_one = rgba_to_color (0, 0, 0, 1.0);
 513
 514         set_source_rgba (wave_context, alpha_one);
 515         set_source_rgba (outline_context, alpha_one);
 516         set_source_rgba (clip_context, alpha_one);
 517         set_source_rgba (zero_context, alpha_one);
 518
 519         /* ensure single-pixel lines */
 520
 521         wave_context->set_line_width (1.0);
 522         wave_context->translate (0.5, +0.5);
 523
 524         outline_context->set_line_cap (Cairo::LINE_CAP_ROUND);
 525         outline_context->set_line_width (1.0);
 526         outline_context->translate (0.5, +0.5);
 527
 528         clip_context->set_line_width (1.0);
 529         clip_context->translate (0.5, +0.5);
 530
 531         zero_context->set_line_width (1.0);
 532         zero_context->translate (0.5, +0.5);
 533
 534         /* the height of the clip-indicator should be at most 7 pixels,
 535          * or 5% of the height of the waveview item.
 536          */
 537
 538         const double clip_height = min (7.0, ceil (_height * 0.05));
 539
 540         /* There are 3 possible components to draw at each x-axis position: the
 541            waveform "line", the zero line and an outline/clip indicator.  We
 542            have to decide which of the 3 to draw at each position, pixel by
 543            pixel. This makes the rendering less efficient but it is the only
 544            way I can see to do this correctly.
 545
 546            To avoid constant source swapping and stroking, we draw the components separately
 547            onto four alpha only image surfaces for use as a mask.
 548
 549            With only 1 pixel of spread between the top and bottom of the line,
 550            we just draw the upper outline/clip indicator.
 551
 552            With 2 pixels of spread, we draw the upper and lower outline clip
 553            indicators.
 554
 555            With 3 pixels of spread we draw the upper and lower outline/clip
 556            indicators and at least 1 pixel of the waveform line.
 557
 558            With 5 pixels of spread, we draw all components.
 559
 560            We can do rectified as two separate passes because we have a much
 561            easier decision regarding whether to draw the waveform line. We
 562            always draw the clip/outline indicators.
 563         */
 564
 565         if (_shape == WaveView::Rectified) {
 566
 567                 for (int i = 0; i < n_peaks; ++i) {
 568
 569                         /* waveform line */
 570
 571                         if (tips[i].spread >= 1.0) {
 572                                 wave_context->move_to (i, tips[i].top);
 573                                 wave_context->line_to (i, tips[i].bot);
 574                         }
 575
 576                         if (_global_show_waveform_clipping && (tips[i].clip_max)) {
 577                                 clip_context->move_to (i, tips[i].top);
 578                                 /* clip-indicating upper terminal line */
 579                                 clip_context->rel_line_to (0, min (clip_height, ceil(tips[i].spread + .5)));
 580                         } else {
 581                                 outline_context->move_to (i, tips[i].top);
 582                                 /* normal upper terminal dot */
 583                                 outline_context->close_path ();
 584                         }
 585                 }
 586
 587                 wave_context->stroke ();
 588                 clip_context->stroke ();
 589                 outline_context->stroke ();
 590
 591         } else {
 592                 const double height_2 = (_height - 4.0) * .5;
 593
 594                 for (int i = 0; i < n_peaks; ++i) {
 595
 596                         /* waveform line */
 597
 598                         if (tips[i].spread >= 2.0) {
 599                                 wave_context->move_to (i, tips[i].top);
 600                                 wave_context->line_to (i, tips[i].bot);
 601                         }
 602                         if (i > 0) {
 603                                 if (tips[i-1].top + 2 < tips[i].bot) {
 604                                         wave_context->move_to (i-1, tips[i-1].top);
 605                                         wave_context->line_to (i, tips[i].bot);
 606                                 }
 607                                 else if (tips[i-1].bot > tips[i].top + 2) {
 608                                         wave_context->move_to (i-1, tips[i-1].bot);
 609                                         wave_context->line_to (i, tips[i].top);
 610                                 }
 611                         }
 612
 613                         /* zero line */
 614
 615                         if (tips[i].spread >= 5.0 && show_zero_line()) {
 616                                 zero_context->move_to (i, floor(height_2));
 617                                 zero_context->rel_line_to (1.0, 0);
 618                         }
 619
 620                         if (tips[i].spread > 1.0) {
 621                                 /* lower outline/clip indicator */
 622                                 if (_global_show_waveform_clipping && tips[i].clip_min) {
 623                                         clip_context->move_to (i, tips[i].bot);
 624                                         /* clip-indicating lower terminal line */
 625                                         const double sign = tips[i].bot > height_2 ? -1 : 1;
 626                                         clip_context->rel_line_to (0, sign * min (clip_height, ceil (tips[i].spread + .5)));
 627                                 } else {
 628                                         outline_context->move_to (i, tips[i].bot);
 629                                         /* normal lower terminal dot */
 630                                         outline_context->close_path ();
 631                                 }
 632                         } else {
 633                                 if (tips[i].clip_min) {
 634                                         // make sure we draw the clip
 635                                         tips[i].clip_max = true;
 636                                 }
 637                         }
 638
 639                         /* upper outline/clip indicator */
 640                         if (_global_show_waveform_clipping && tips[i].clip_max) {
 641                                 clip_context->move_to (i, tips[i].top);
 642                                 /* clip-indicating upper terminal line */
 643                                 const double sign = tips[i].top > height_2 ? -1 : 1;
 644                                 clip_context->rel_line_to (0, sign * min(clip_height, ceil(tips[i].spread + .5)));
 645                         } else {
 646                                 outline_context->move_to (i, tips[i].top);
 647                                 /* normal upper terminal dot */
 648                                 outline_context->close_path ();
 649                         }
 650                 }
 651
 652                 wave_context->stroke ();
 653                 outline_context->stroke ();
 654                 clip_context->stroke ();
 655                 zero_context->stroke ();
 656         }
 657
 658         Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (image);
 659
 660         /* Here we set a source colour and use the various components as a mask. */
 661
 662         if (gradient_depth() != 0.0) {
 663
 664                 Cairo::RefPtr<Cairo::LinearGradient> gradient (Cairo::LinearGradient::create (0, 0, 0, _height));
 665
 666                 double stops[3];
 667
 668                 double r, g, b, a;
 669
 670                 if (_shape == Rectified) {
 671                         stops[0] = 0.1;
 672                         stops[1] = 0.3;
 673                         stops[2] = 0.9;
 674                 } else {
 675                         stops[0] = 0.1;
 676                         stops[1] = 0.5;
 677                         stops[2] = 0.9;
 678                 }
 679
 680                 color_to_rgba (_fill_color, r, g, b, a);
 681                 gradient->add_color_stop_rgba (stops[1], r, g, b, a);
 682                 /* generate a new color for the middle of the gradient */
 683                 double h, s, v;
 684                 color_to_hsv (_fill_color, h, s, v);
 685                 /* change v towards white */
 686                 v *= 1.0 - gradient_depth();
 687                 Color center = hsva_to_color (h, s, v, a);
 688                 color_to_rgba (center, r, g, b, a);
 689
 690                 gradient->add_color_stop_rgba (stops[0], r, g, b, a);
 691                 gradient->add_color_stop_rgba (stops[2], r, g, b, a);
 692
 693                 context->set_source (gradient);
 694         } else {
 695                 set_source_rgba (context, _fill_color);
 696         }
 697
 698         context->mask (images.wave, 0, 0);
 699         context->fill ();
 700
 701         set_source_rgba (context, _outline_color);
 702         context->mask (images.outline, 0, 0);
 703         context->fill ();
 704
 705         set_source_rgba (context, _clip_color);
 706         context->mask (images.clip, 0, 0);
 707         context->fill ();
 708
 709         set_source_rgba (context, _zero_color);
 710         context->mask (images.zero, 0, 0);
 711         context->fill ();
 712
 713 }
 714
 715 void
 716 WaveView::get_image (Cairo::RefPtr<Cairo::ImageSurface>& image, framepos_t start, framepos_t end, double& image_offset) const
 717 {
 718         vector <CacheEntry> caches;
 719
 720         if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
 721
 722                 caches = _image_cache.find (_region->audio_source ())->second;
 723         }
 724
 725         /* Find a suitable ImageSurface.
 726         */
 727         for (uint32_t i = 0; i < caches.size (); ++i) {
 728
 729                 if (_channel != caches[i].channel
 730                     || _height != caches[i].height
 731                     || _region_amplitude != caches[i].amplitude
 732                     || _fill_color != caches[i].fill_color) {
 733
 734                         continue;
 735                 }
 736
 737                 framepos_t segment_start = caches[i].start;
 738                 framepos_t segment_end = caches[i].end;
 739
 740                 if (end <= segment_end && start >= segment_start) {
 741                         image_offset = (segment_start - _region_start) / _samples_per_pixel;
 742                         image = caches[i].image;
 743
 744                         return;
 745                 }
 746         }
 747
 748         consolidate_image_cache ();
 749
 750         /* sample position is canonical here, and we want to generate
 751          * an image that spans about twice the canvas width
 752          */
 753
 754         const framepos_t center = start + ((end - start) / 2);
 755         const framecnt_t canvas_samples = _canvas->visible_area().width() * _samples_per_pixel; /* one canvas width */
 756
 757         /* we can request data from anywhere in the Source, between 0 and its length
 758          */
 759
 760         framepos_t sample_start = max ((framepos_t) 0, (center - canvas_samples));
 761         framepos_t sample_end = min (center + canvas_samples, _region->source_length (0));
 762
 763         const int n_peaks = llrintf ((sample_end - sample_start)/ (double) _samples_per_pixel);
 764
 765         boost::scoped_array<ARDOUR::PeakData> peaks (new PeakData[n_peaks]);
 766
 767         _region->read_peaks (peaks.get(), n_peaks,
 768                              sample_start, sample_end - sample_start,
 769                              _channel,
 770                              _samples_per_pixel);
 771
 772         image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, n_peaks, _height);
 773
 774         draw_image (image, peaks.get(), n_peaks);
 775
 776         _image_cache[_region->audio_source ()].push_back (CacheEntry (_channel, _height, _region_amplitude, _fill_color, sample_start,  sample_end, image));
 777
 778         image_offset = (sample_start - _region->start()) / _samples_per_pixel;
 779
 780         //cerr << "_image_cache size is : " << _image_cache.size() << " entries for this audiosource : " << _image_cache.find (_region->audio_source ())->second.size() << endl;
 781
 782         return;
 783 }
 784
 785 void
 786 WaveView::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
 787 {
 788         assert (_samples_per_pixel != 0);
 789
 790         if (!_region) {
 791                 return;
 792         }
 793
 794         Rect self = item_to_window (Rect (0.0, 0.0, _region->length() / _samples_per_pixel, _height));
 795         boost::optional<Rect> d = self.intersection (area);
 796
 797         if (!d) {
 798                 return;
 799         }
 800
 801         Rect draw = d.get();
 802
 803         /* window coordinates - pixels where x=0 is the left edge of the canvas
 804          * window. We round down in case we were asked to
 805          * draw "between" pixels at the start and/or end.
 806          */
 807
 808         double draw_start = floor (draw.x0);
 809         const double draw_end = floor (draw.x1);
 810
 811         // cerr << "Need to draw " << draw_start << " .. " << draw_end << endl;
 812
 813         /* image coordnates: pixels where x=0 is the start of this waveview,
 814          * wherever it may be positioned. thus image_start=N means "an image
 815          * that beings N pixels after the start of region that this waveview is
 816          * representing.
 817          */
 818
 819         const framepos_t image_start = window_to_image (self.x0, draw_start);
 820         const framepos_t image_end = window_to_image (self.x0, draw_end);
 821
 822         // cerr << "Image/WV space: " << image_start << " .. " << image_end << endl;
 823
 824         /* sample coordinates - note, these are not subject to rounding error */
 825         framepos_t sample_start = _region_start + (image_start * _samples_per_pixel);
 826         framepos_t sample_end   = _region_start + (image_end * _samples_per_pixel);
 827
 828         // cerr << "Sample space: " << sample_start << " .. " << sample_end << endl;
 829
 830         Cairo::RefPtr<Cairo::ImageSurface> image;
 831         double image_offset = 0;
 832
 833         get_image (image, sample_start, sample_end, image_offset);
 834
 835         // cerr << "Offset into image to place at zero: " << image_offset << endl;
 836
 837         if (_start_shift && (sample_start == _region_start) && (self.x0 == draw.x0)) {
 838                 /* we are going to draw the first pixel for this region, but
 839                    we may not want this to overlap a border around the
 840                    waveform. If so, _start_shift will be set.
 841                 */
 842                 //cerr << name.substr (23) << " ss = " << sample_start << " rs = " << _region_start << " sf = " << _start_shift << " ds = " << draw_start << " self = " << self << " draw = " << draw << endl;
 843                 //draw_start += _start_shift;
 844                 //image_offset += _start_shift;
 845         }
 846
 847         context->rectangle (draw_start, draw.y0, draw_end - draw_start, draw.height());
 848
 849         /* round image origin position to an exact pixel in device space to
 850          * avoid blurring
 851          */
 852
 853         double x  = self.x0 + image_offset;
 854         double y  = self.y0;
 855         context->user_to_device (x, y);
 856         x = round (x);
 857         y = round (y);
 858         context->device_to_user (x, y);
 859
 860         context->set_source (image, x, y);
 861         context->fill ();
 862
 863 }
 864
 865 void
 866 WaveView::compute_bounding_box () const
 867 {
 868         if (_region) {
 869                 _bounding_box = Rect (0.0, 0.0, _region->length() / _samples_per_pixel, _height);
 870         } else {
 871                 _bounding_box = boost::optional<Rect> ();
 872         }
 873
 874         _bounding_box_dirty = false;
 875 }
 876
 877 void
 878 WaveView::set_height (Distance height)
 879 {
 880         if (height != _height) {
 881                 begin_change ();
 882
 883                 invalidate_image_cache ();
 884                 _height = height;
 885
 886                 _bounding_box_dirty = true;
 887                 end_change ();
 888         }
 889 }
 890
 891 void
 892 WaveView::set_channel (int channel)
 893 {
 894         if (channel != _channel) {
 895                 begin_change ();
 896
 897                 invalidate_image_cache ();
 898                 _channel = channel;
 899
 900                 _bounding_box_dirty = true;
 901                 end_change ();
 902         }
 903 }
 904
 905 void
 906 WaveView::set_logscaled (bool yn)
 907 {
 908         if (_logscaled != yn) {
 909                 begin_visual_change ();
 910                 invalidate_image_cache ();
 911                 _logscaled = yn;
 912                 end_visual_change ();
 913         }
 914 }
 915
 916 void
 917 WaveView::gain_changed ()
 918 {
 919         begin_visual_change ();
 920         invalidate_image_cache ();
 921         _region_amplitude = _region->scale_amplitude ();
 922         end_visual_change ();
 923 }
 924
 925 void
 926 WaveView::set_zero_color (Color c)
 927 {
 928         if (_zero_color != c) {
 929                 begin_visual_change ();
 930                 invalidate_image_cache ();
 931                 _zero_color = c;
 932                 end_visual_change ();
 933         }
 934 }
 935
 936 void
 937 WaveView::set_clip_color (Color c)
 938 {
 939         if (_clip_color != c) {
 940                 begin_visual_change ();
 941                 invalidate_image_cache ();
 942                 _clip_color = c;
 943                 end_visual_change ();
 944         }
 945 }
 946
 947 void
 948 WaveView::set_show_zero_line (bool yn)
 949 {
 950         if (_show_zero != yn) {
 951                 begin_visual_change ();
 952                 invalidate_image_cache ();
 953                 _show_zero = yn;
 954                 end_visual_change ();
 955         }
 956 }
 957
 958 void
 959 WaveView::set_shape (Shape s)
 960 {
 961         if (_shape != s) {
 962                 begin_visual_change ();
 963                 invalidate_image_cache ();
 964                 _shape = s;
 965                 end_visual_change ();
 966         }
 967 }
 968
 969 void
 970 WaveView::set_amplitude_above_axis (double a)
 971 {
 972         if (_amplitude_above_axis != a) {
 973                 begin_visual_change ();
 974                 invalidate_image_cache ();
 975                 _amplitude_above_axis = a;
 976                 end_visual_change ();
 977         }
 978 }
 979
 980 void
 981 WaveView::set_global_shape (Shape s)
 982 {
 983         if (_global_shape != s) {
 984                 _global_shape = s;
 985                 VisualPropertiesChanged (); /* EMIT SIGNAL */
 986         }
 987 }
 988
 989 void
 990 WaveView::set_global_logscaled (bool yn)
 991 {
 992         if (_global_logscaled != yn) {
 993                 _global_logscaled = yn;
 994                 VisualPropertiesChanged (); /* EMIT SIGNAL */
 995         }
 996 }
 997
 998 void
 999 WaveView::set_region_start (frameoffset_t start)
1000 {
1001         if (!_region) {
1002                 return;
1003         }
1004
1005         if (_region_start == start) {
1006                 return;
1007         }
1008
1009         begin_change ();
1010         _region_start = start;
1011         _bounding_box_dirty = true;
1012         end_change ();
1013 }
1014
1015 void
1016 WaveView::region_resized ()
1017 {
1018         /* Called when the region start or end (thus length) has changed.
1019         */
1020
1021         if (!_region) {
1022                 return;
1023         }
1024
1025         begin_change ();
1026         _region_start = _region->start();
1027         _bounding_box_dirty = true;
1028         end_change ();
1029 }
1030
1031 void
1032 WaveView::set_global_gradient_depth (double depth)
1033 {
1034         if (_global_gradient_depth != depth) {
1035                 _global_gradient_depth = depth;
1036                 VisualPropertiesChanged (); /* EMIT SIGNAL */
1037         }
1038 }
1039
1040 void
1041 WaveView::set_global_show_waveform_clipping (bool yn)
1042 {
1043         if (_global_show_waveform_clipping != yn) {
1044                 _global_show_waveform_clipping = yn;
1045                 ClipLevelChanged ();
1046         }
1047 }
1048
1049 void
1050 WaveView::set_start_shift (double pixels)
1051 {
1052         if (pixels < 0) {
1053                 return;
1054         }
1055
1056         begin_visual_change ();
1057         _start_shift = pixels;
1058         end_visual_change ();
1059 }
1060