gtk2_ardour/ghostregion.cc

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "ardour/parameter_descriptor.h"
  21
  22 #include "evoral/Note.hpp"
  23 #include "canvas/container.h"
  24 #include "canvas/polygon.h"
  25 #include "canvas/rectangle.h"
  26 #include "canvas/wave_view.h"
  27 #include "canvas/debug.h"
  28
  29 #include "automation_time_axis.h"
  30 #include "ghostregion.h"
  31 #include "midi_streamview.h"
  32 #include "midi_time_axis.h"
  33 #include "region_view.h"
  34 #include "rgb_macros.h"
  35 #include "note.h"
  36 #include "hit.h"
  37 #include "ui_config.h"
  38
  39 using namespace std;
  40 using namespace Editing;
  41 using namespace ArdourCanvas;
  42 using namespace ARDOUR;
  43
  44 GhostRegion::GhostRegion(RegionView& rv,
  45                          ArdourCanvas::Container* parent,
  46                          TimeAxisView& tv,
  47                          TimeAxisView& source_tv,
  48                          double initial_pos)
  49     : parent_rv(rv)
  50     , trackview(tv)
  51     , source_trackview(source_tv)
  52 {
  53         group = new ArdourCanvas::Container (parent);
  54         CANVAS_DEBUG_NAME (group, "ghost region");
  55         group->set_position (ArdourCanvas::Duple (initial_pos, 0));
  56
  57         base_rect = new ArdourCanvas::Rectangle (group);
  58         CANVAS_DEBUG_NAME (base_rect, "ghost region rect");
  59         base_rect->set_x0 (0);
  60         base_rect->set_y0 (1.0);
  61         base_rect->set_y1 (trackview.current_height());
  62         base_rect->set_outline (false);
  63
  64         if (!is_automation_ghost()) {
  65                 base_rect->hide();
  66         }
  67
  68         GhostRegion::set_colors();
  69
  70         /* the parent group of a ghostregion is a dedicated group for ghosts,
  71            so the new ghost would want to get to the top of that group*/
  72         group->raise_to_top ();
  73 }
  74
  75 GhostRegion::~GhostRegion ()
  76 {
  77         parent_rv.remove_ghost(this);
  78         trackview.erase_ghost(this);
  79         delete base_rect;
  80         delete group;
  81 }
  82
  83 void
  84 GhostRegion::set_duration (double units)
  85 {
  86         base_rect->set_x1 (units);
  87 }
  88
  89 void
  90 GhostRegion::set_height ()
  91 {
  92         base_rect->set_y1 (trackview.current_height());
  93 }
  94
  95 void
  96 GhostRegion::set_colors ()
  97 {
  98         if (is_automation_ghost()) {
  99                 base_rect->set_fill_color (UIConfiguration::instance().color_mod ("ghost track base", "ghost track base"));
 100         }
 101 }
 102
 103 guint
 104 GhostRegion::source_track_color(unsigned char alpha)
 105 {
 106         Gdk::Color color = source_trackview.color();
 107         return RGBA_TO_UINT (color.get_red() / 256, color.get_green() / 256, color.get_blue() / 256, alpha);
 108 }
 109
 110 bool
 111 GhostRegion::is_automation_ghost()
 112 {
 113         return (dynamic_cast<AutomationTimeAxisView*>(&trackview)) != 0;
 114 }
 115
 116 AudioGhostRegion::AudioGhostRegion(RegionView& rv,
 117                                    TimeAxisView& tv,
 118                                    TimeAxisView& source_tv,
 119                                    double initial_unit_pos)
 120     : GhostRegion(rv, tv.ghost_group(), tv, source_tv, initial_unit_pos)
 121 {
 122
 123 }
 124
 125 void
 126 AudioGhostRegion::set_samples_per_pixel (double fpp)
 127 {
 128         for (vector<WaveView*>::iterator i = waves.begin(); i != waves.end(); ++i) {
 129                 (*i)->set_samples_per_pixel (fpp);
 130         }
 131 }
 132
 133 void
 134 AudioGhostRegion::set_height ()
 135 {
 136         vector<WaveView*>::iterator i;
 137         uint32_t n;
 138
 139         GhostRegion::set_height();
 140
 141         double const ht = ((trackview.current_height()) / (double) waves.size());
 142
 143         for (n = 0, i = waves.begin(); i != waves.end(); ++i, ++n) {
 144                 (*i)->set_height (ht);
 145                 (*i)->set_y_position (n * ht);
 146         }
 147 }
 148
 149 void
 150 AudioGhostRegion::set_colors ()
 151 {
 152         GhostRegion::set_colors();
 153         guint fill_color;
 154
 155         if (is_automation_ghost()) {
 156                 fill_color = UIConfiguration::instance().color ("ghost track wave fill");
 157         }
 158         else {
 159                 fill_color = source_track_color(200);
 160         }
 161
 162         for (uint32_t n=0; n < waves.size(); ++n) {
 163                 waves[n]->set_outline_color (UIConfiguration::instance().color ("ghost track wave"));
 164                 waves[n]->set_fill_color (fill_color);
 165                 waves[n]->set_clip_color (UIConfiguration::instance().color ("ghost track wave clip"));
 166                 waves[n]->set_zero_color (UIConfiguration::instance().color ("ghost track zero line"));
 167         }
 168 }
 169
 170 /** The general constructor; called when the destination timeaxisview doesn't have
 171  *  a midistreamview.
 172  *
 173  *  @param rv The parent RegionView that is being ghosted.
 174  *  @param tv TimeAxisView that this ghost region is on.
 175  *  @param source_tv TimeAxisView that we are the ghost for.
 176  */
 177 MidiGhostRegion::MidiGhostRegion(RegionView& rv,
 178                                  TimeAxisView& tv,
 179                                  TimeAxisView& source_tv,
 180                                  double initial_unit_pos)
 181     : GhostRegion(rv, tv.ghost_group(), tv, source_tv, initial_unit_pos)
 182     , _optimization_iterator(events.end())
 183 {
 184         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 185
 186         base_rect->lower_to_bottom();
 187         update_range ();
 188
 189         midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
 190 }
 191
 192 /**
 193  *  @param rv The parent RegionView being ghosted.
 194  *  @param msv MidiStreamView that this ghost region is on.
 195  *  @param source_tv TimeAxisView that we are the ghost for.
 196  */
 197 MidiGhostRegion::MidiGhostRegion(RegionView& rv,
 198                                  MidiStreamView& msv,
 199                                  TimeAxisView& source_tv,
 200                                  double initial_unit_pos)
 201     : GhostRegion(rv,
 202                   msv.midi_underlay_group,
 203                   msv.trackview(),
 204                   source_tv,
 205                   initial_unit_pos)
 206     , _optimization_iterator(events.end())
 207 {
 208         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 209
 210         base_rect->lower_to_bottom();
 211         update_range ();
 212
 213         midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
 214 }
 215
 216 MidiGhostRegion::~MidiGhostRegion()
 217 {
 218         clear_events ();
 219 }
 220
 221 MidiGhostRegion::GhostEvent::GhostEvent (NoteBase* e, ArdourCanvas::Container* g)
 222         : event (e)
 223 {
 224         Hit* hit = NULL;
 225         if (dynamic_cast<Note*>(e)) {
 226                 item = new ArdourCanvas::Rectangle(
 227                         g, ArdourCanvas::Rect(e->x0(), e->y0(), e->x1(), e->y1()));
 228         } else if ((hit = dynamic_cast<Hit*>(e))) {
 229                 ArdourCanvas::Polygon* poly = new ArdourCanvas::Polygon(g);
 230                 poly->set(Hit::points(e->y1() - e->y0()));
 231                 poly->set_position(hit->position());
 232                 item = poly;
 233         }
 234
 235         CANVAS_DEBUG_NAME (item, "ghost note item");
 236 }
 237
 238 MidiGhostRegion::GhostEvent::~GhostEvent ()
 239 {
 240         /* event is not ours to delete */
 241         delete item;
 242 }
 243
 244 void
 245 MidiGhostRegion::set_samples_per_pixel (double /*spu*/)
 246 {
 247 }
 248
 249 /** @return MidiStreamView that we are providing a ghost for */
 250 MidiStreamView*
 251 MidiGhostRegion::midi_view ()
 252 {
 253         StreamView* sv = source_trackview.view ();
 254         assert (sv);
 255         MidiStreamView* msv = dynamic_cast<MidiStreamView*> (sv);
 256         assert (msv);
 257
 258         return msv;
 259 }
 260
 261 void
 262 MidiGhostRegion::set_height ()
 263 {
 264         GhostRegion::set_height();
 265         set_contents_height ();
 266 }
 267
 268 void
 269 MidiGhostRegion::set_colors()
 270 {
 271         GhostRegion::set_colors();
 272         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 273
 274         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 275                 (*it).second->item->set_fill_color (UIConfiguration::instance().color_mod((*it).second->event->base_color(), "ghost track midi fill"));
 276                 (*it).second->item->set_outline_color (_outline);
 277         }
 278 }
 279
 280 static double
 281 note_height(TimeAxisView& trackview, MidiStreamView* mv)
 282 {
 283         const double tv_height  = trackview.current_height();
 284         const double note_range = mv->contents_note_range();
 285
 286         return std::max(1.0, floor(tv_height / note_range - 1.0));
 287 }
 288
 289 static double
 290 note_y(TimeAxisView& trackview, MidiStreamView* mv, uint8_t note_num)
 291 {
 292         const double tv_height  = trackview.current_height();
 293         const double note_range = mv->contents_note_range();
 294         const double s          = tv_height / note_range;
 295
 296         return tv_height - (note_num + 1 - mv->lowest_note()) * s;
 297 }
 298
 299 void
 300 MidiGhostRegion::update_range ()
 301 {
 302         MidiStreamView* mv = midi_view();
 303
 304         if (!mv) {
 305                 return;
 306         }
 307
 308         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 309                 uint8_t const note_num = (*it).second->event->note()->note();
 310
 311                 if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
 312                         (*it).second->item->hide();
 313                 } else {
 314                         (*it).second->item->show();
 315                 }
 316         }
 317 }
 318
 319 void
 320 MidiGhostRegion::set_contents_height ()
 321 {
 322         MidiStreamView* mv = midi_view();
 323
 324         if (!mv) {
 325                 return;
 326         }
 327
 328         double const h = note_height(trackview, mv);
 329
 330         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 331                 uint8_t const note_num = (*it).second->event->note()->note();
 332
 333                 double const y = note_y(trackview, mv, note_num);
 334
 335                 if ((_tmp_rect = dynamic_cast<ArdourCanvas::Rectangle*>((*it).second->item))) {
 336                         _tmp_rect->set (ArdourCanvas::Rect (_tmp_rect->x0(), y, _tmp_rect->x1(), y + h));
 337                 } else if ((_tmp_poly = dynamic_cast<ArdourCanvas::Polygon*>((*it).second->item))) {
 338                         Duple position = _tmp_poly->position();
 339                         position.y = y;
 340                         _tmp_poly->set_position(position);
 341                         _tmp_poly->set(Hit::points(h));
 342                 }
 343         }
 344 }
 345
 346 void
 347 MidiGhostRegion::add_note (NoteBase* n)
 348 {
 349         GhostEvent* event = new GhostEvent (n, group);
 350         events.insert (make_pair (n->note(), event));
 351
 352         event->item->set_fill_color (UIConfiguration::instance().color_mod(n->base_color(), "ghost track midi fill"));
 353         event->item->set_outline_color (_outline);
 354
 355         MidiStreamView* mv = midi_view();
 356
 357         if (mv) {
 358                 uint8_t const note_num = n->note()->note();
 359                 double const  h        = note_height(trackview, mv);
 360                 double const  y        = note_y(trackview, mv, note_num);
 361
 362                 if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
 363                         event->item->hide();
 364                 } else {
 365                         if ((_tmp_rect = dynamic_cast<ArdourCanvas::Rectangle*>(event->item))) {
 366                                 _tmp_rect->set (ArdourCanvas::Rect (_tmp_rect->x0(), y, _tmp_rect->x1(), y + h));
 367                         } else if ((_tmp_poly = dynamic_cast<ArdourCanvas::Polygon*>(event->item))) {
 368                                 Duple position = _tmp_poly->position();
 369                                 position.y = y;
 370                                 _tmp_poly->set_position(position);
 371                                 _tmp_poly->set(Hit::points(h));
 372                         }
 373                 }
 374         }
 375 }
 376
 377 void
 378 MidiGhostRegion::clear_events()
 379 {
 380         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 381                 delete (*it).second;
 382         }
 383
 384         events.clear();
 385         _optimization_iterator = events.end ();
 386 }
 387
 388 /** Update the x positions of our representation of a parent's note.
 389  *  @param parent The CanvasNote from the parent MidiRegionView.
 390  */
 391 void
 392 MidiGhostRegion::update_note (Note* note)
 393 {
 394         MidiStreamView* mv = midi_view();
 395
 396         if (!mv) {
 397                 return;
 398         }
 399
 400         GhostEvent* ev = find_event (note);
 401
 402         if (!ev) {
 403                 return;
 404         }
 405
 406         uint8_t const note_num = note->note()->note();
 407
 408         double const y = note_y(trackview, mv, note_num);
 409         double const h = note_height(trackview, mv);
 410
 411         if ((_tmp_rect = dynamic_cast<ArdourCanvas::Rectangle*>(ev->item))) {
 412                 _tmp_rect->set (ArdourCanvas::Rect (note->x0(), y, note->x1(), y + h));
 413         }
 414
 415 }
 416
 417 /** Update the x positions of our representation of a parent's hit.
 418  *  @param hit The CanvasHit from the parent MidiRegionView.
 419  */
 420 void
 421 MidiGhostRegion::update_hit (Hit* hit)
 422 {
 423         MidiStreamView* mv = midi_view();
 424
 425         if (!mv) {
 426                 return;
 427         }
 428
 429         GhostEvent* ev = find_event (hit);
 430
 431         if (!ev) {
 432                 return;
 433         }
 434
 435         uint8_t const note_num = ev->event->note()->note();
 436
 437         double const h = note_height(trackview, mv);
 438         double const y = note_y(trackview, mv, note_num);
 439
 440         if ((_tmp_poly = dynamic_cast<ArdourCanvas::Polygon*>(ev->item))) {
 441                 ArdourCanvas::Duple ppos = hit->position();
 442                 ArdourCanvas::Duple gpos = _tmp_poly->position();
 443                 gpos.x = ppos.x;
 444                 gpos.y = y;
 445                 _tmp_poly->set_position(gpos);
 446                 _tmp_poly->set(Hit::points(h));
 447         }
 448 }
 449
 450 void
 451 MidiGhostRegion::remove_note (NoteBase* note)
 452 {
 453         EventList::iterator f = events.find (note->note());
 454         if (f == events.end()) {
 455                 return;
 456         }
 457
 458         delete (*f).second;
 459         events.erase (f);
 460
 461         _optimization_iterator = events.end ();
 462 }
 463
 464 /** Given a note in our parent region (ie the actual MidiRegionView), find our
 465  *  representation of it.
 466  *  @return Our Event, or 0 if not found.
 467  */
 468
 469 MidiGhostRegion::GhostEvent *
 470 MidiGhostRegion::find_event (NoteBase* parent)
 471 {
 472         /* we are using _optimization_iterator to speed up the common case where a caller
 473            is going through our notes in order.
 474         */
 475
 476         if (_optimization_iterator != events.end()) {
 477                 ++_optimization_iterator;
 478         }
 479
 480         if (_optimization_iterator != events.end() && (*_optimization_iterator).second->event == parent) {
 481                 return (*_optimization_iterator).second;
 482         }
 483
 484         _optimization_iterator = events.find (parent->note());
 485         if (_optimization_iterator != events.end()) {
 486                 return (*_optimization_iterator).second;
 487         }
 488
 489         return 0;
 490 }