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     , _note_group (new ArdourCanvas::Container (group))
 183     , _optimization_iterator(events.end())
 184 {
 185         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 186
 187         base_rect->lower_to_bottom();
 188 }
 189
 190 /**
 191  *  @param rv The parent RegionView being ghosted.
 192  *  @param msv MidiStreamView that this ghost region is on.
 193  *  @param source_tv TimeAxisView that we are the ghost for.
 194  */
 195 MidiGhostRegion::MidiGhostRegion(RegionView& rv,
 196                                  MidiStreamView& msv,
 197                                  TimeAxisView& source_tv,
 198                                  double initial_unit_pos)
 199     : GhostRegion(rv,
 200                   msv.midi_underlay_group,
 201                   msv.trackview(),
 202                   source_tv,
 203                   initial_unit_pos)
 204     , _note_group (new ArdourCanvas::Container (group))
 205     , _optimization_iterator(events.end())
 206 {
 207         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 208
 209         base_rect->lower_to_bottom();
 210 }
 211
 212 MidiGhostRegion::~MidiGhostRegion()
 213 {
 214         clear_events ();
 215         delete _note_group;
 216 }
 217
 218 MidiGhostRegion::GhostEvent::GhostEvent (NoteBase* e, ArdourCanvas::Container* g)
 219         : event (e)
 220 {
 221
 222         if (dynamic_cast<Note*>(e)) {
 223                 item = new ArdourCanvas::Rectangle(
 224                         g, ArdourCanvas::Rect(e->x0(), e->y0(), e->x1(), e->y1()));
 225                 is_hit = false;
 226         } else {
 227                 Hit* hit = dynamic_cast<Hit*>(e);
 228                 if (!hit) {
 229                         return;
 230                 }
 231                 ArdourCanvas::Polygon* poly = new ArdourCanvas::Polygon(g);
 232                 poly->set(Hit::points(e->y1() - e->y0()));
 233                 poly->set_position(hit->position());
 234                 item = poly;
 235                 is_hit = true;
 236         }
 237
 238         CANVAS_DEBUG_NAME (item, "ghost note item");
 239 }
 240
 241 MidiGhostRegion::GhostEvent::~GhostEvent ()
 242 {
 243         /* event is not ours to delete */
 244         delete item;
 245 }
 246
 247 void
 248 MidiGhostRegion::set_samples_per_pixel (double /*spu*/)
 249 {
 250 }
 251
 252 /** @return MidiStreamView that we are providing a ghost for */
 253 MidiStreamView*
 254 MidiGhostRegion::midi_view ()
 255 {
 256         StreamView* sv = source_trackview.view ();
 257         assert (sv);
 258         MidiStreamView* msv = dynamic_cast<MidiStreamView*> (sv);
 259         assert (msv);
 260
 261         return msv;
 262 }
 263
 264 void
 265 MidiGhostRegion::set_height ()
 266 {
 267         GhostRegion::set_height();
 268         update_contents_height ();
 269 }
 270
 271 void
 272 MidiGhostRegion::set_colors()
 273 {
 274         GhostRegion::set_colors();
 275         _outline = UIConfiguration::instance().color ("ghost track midi outline");
 276
 277         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 278                 it->second->item->set_fill_color (UIConfiguration::instance().color_mod((*it).second->event->base_color(), "ghost track midi fill"));
 279                 it->second->item->set_outline_color (_outline);
 280         }
 281 }
 282
 283 static double
 284 note_height(TimeAxisView& trackview, MidiStreamView* mv)
 285 {
 286         const double tv_height  = trackview.current_height();
 287         const double note_range = mv->contents_note_range();
 288
 289         return std::max(1.0, floor(tv_height / note_range - 1.0));
 290 }
 291
 292 static double
 293 note_y(TimeAxisView& trackview, MidiStreamView* mv, uint8_t note_num)
 294 {
 295         const double tv_height  = trackview.current_height();
 296         const double note_range = mv->contents_note_range();
 297         const double s          = tv_height / note_range;
 298
 299         return tv_height - (note_num + 1 - mv->lowest_note()) * s;
 300 }
 301
 302 void
 303 MidiGhostRegion::update_contents_height ()
 304 {
 305         MidiStreamView* mv = midi_view();
 306
 307         if (!mv) {
 308                 return;
 309         }
 310
 311         double const h = note_height(trackview, mv);
 312
 313         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 314                 uint8_t const note_num = it->second->event->note()->note();
 315
 316                 double const y = note_y(trackview, mv, note_num);
 317
 318                 if (!it->second->is_hit) {
 319                         _tmp_rect = static_cast<ArdourCanvas::Rectangle*>(it->second->item);
 320                         _tmp_rect->set (ArdourCanvas::Rect (_tmp_rect->x0(), y, _tmp_rect->x1(), y + h));
 321                 } else {
 322                         _tmp_poly = static_cast<ArdourCanvas::Polygon*>(it->second->item);
 323                         Duple position = _tmp_poly->position();
 324                         position.y = y;
 325                         _tmp_poly->set_position(position);
 326                         _tmp_poly->set(Hit::points(h));
 327                 }
 328         }
 329 }
 330
 331 void
 332 MidiGhostRegion::add_note (NoteBase* n)
 333 {
 334         GhostEvent* event = new GhostEvent (n, _note_group);
 335         events.insert (make_pair (n->note(), event));
 336
 337         event->item->set_fill_color (UIConfiguration::instance().color_mod(n->base_color(), "ghost track midi fill"));
 338         event->item->set_outline_color (_outline);
 339
 340         MidiStreamView* mv = midi_view();
 341
 342         if (mv) {
 343                 uint8_t const note_num = n->note()->note();
 344                 double const  h        = note_height(trackview, mv);
 345                 double const  y        = note_y(trackview, mv, note_num);
 346
 347                 if (!n->item()->visible()) {
 348                         event->item->hide();
 349                 } else {
 350                         if (!event->is_hit) {
 351                                 _tmp_rect = static_cast<ArdourCanvas::Rectangle*>(event->item);
 352                                 _tmp_rect->set (ArdourCanvas::Rect (_tmp_rect->x0(), y, _tmp_rect->x1(), y + h));
 353                         } else {
 354                                 _tmp_poly = static_cast<ArdourCanvas::Polygon*>(event->item);
 355                                 Duple position = _tmp_poly->position();
 356                                 position.y = y;
 357                                 _tmp_poly->set_position(position);
 358                                 _tmp_poly->set(Hit::points(h));
 359                         }
 360                 }
 361         }
 362 }
 363
 364 void
 365 MidiGhostRegion::clear_events()
 366 {
 367         _note_group->clear (true);
 368         events.clear ();
 369         _optimization_iterator = events.end();
 370 }
 371
 372 /** Update the x positions of our representation of a parent's note.
 373  *  @param parent The CanvasNote from the parent MidiRegionView.
 374  */
 375 void
 376 MidiGhostRegion::update_note (Note* note, bool hide)
 377 {
 378         MidiStreamView* mv = midi_view();
 379
 380         if (!mv) {
 381                 return;
 382         }
 383
 384         GhostEvent* ev = find_event (note);
 385
 386         if (!ev) {
 387                 return;
 388         }
 389
 390         uint8_t const note_num = note->note()->note();
 391
 392         double const y = note_y(trackview, mv, note_num);
 393         double const h = note_height(trackview, mv);
 394
 395         if (hide) {
 396                 ev->item->hide();
 397         } else if (!ev->is_hit) {
 398                 _tmp_rect = static_cast<ArdourCanvas::Rectangle*>(ev->item);
 399                 _tmp_rect->set (ArdourCanvas::Rect (note->x0(), y, note->x1(), y + h));
 400
 401                 ev->item->show();
 402         }
 403 }
 404
 405 /** Update the x positions of our representation of a parent's hit.
 406  *  @param hit The CanvasHit from the parent MidiRegionView.
 407  */
 408 void
 409 MidiGhostRegion::update_hit (Hit* hit, bool hide)
 410 {
 411         MidiStreamView* mv = midi_view();
 412
 413         if (!mv) {
 414                 return;
 415         }
 416
 417         GhostEvent* ev = find_event (hit);
 418
 419         if (!ev) {
 420                 return;
 421         }
 422
 423         uint8_t const note_num = ev->event->note()->note();
 424
 425         double const h = note_height(trackview, mv);
 426         double const y = note_y(trackview, mv, note_num);
 427
 428         if (hide) {
 429                 ev->item->hide();
 430         } else if (ev->is_hit) {
 431                 _tmp_poly = static_cast<ArdourCanvas::Polygon*>(ev->item);
 432                 ArdourCanvas::Duple ppos = hit->position();
 433                 ArdourCanvas::Duple gpos = _tmp_poly->position();
 434                 gpos.x = ppos.x;
 435                 gpos.y = y;
 436                 _tmp_poly->set_position(gpos);
 437                 _tmp_poly->set(Hit::points(h));
 438
 439                 ev->item->show();
 440         }
 441 }
 442
 443 void
 444 MidiGhostRegion::remove_note (NoteBase* note)
 445 {
 446         EventList::iterator f = events.find (note->note());
 447         if (f == events.end()) {
 448                 return;
 449         }
 450
 451         delete f->second;
 452         events.erase (f);
 453
 454         _optimization_iterator = events.end ();
 455 }
 456
 457 /** Given a note in our parent region (ie the actual MidiRegionView), find our
 458  *  representation of it.
 459  *  @return Our Event, or 0 if not found.
 460  */
 461
 462 MidiGhostRegion::GhostEvent *
 463 MidiGhostRegion::find_event (NoteBase* parent)
 464 {
 465         /* we are using _optimization_iterator to speed up the common case where a caller
 466            is going through our notes in order.
 467         */
 468
 469         if (_optimization_iterator != events.end()) {
 470                 ++_optimization_iterator;
 471                 if (_optimization_iterator != events.end() && _optimization_iterator->second->event == parent) {
 472                         return _optimization_iterator->second;
 473                 }
 474         }
 475
 476         _optimization_iterator = events.find (parent->note());
 477         if (_optimization_iterator != events.end()) {
 478                 return _optimization_iterator->second;
 479         }
 480
 481         return 0;
 482 }