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 "evoral/Note.hpp"
  21 #include "canvas/container.h"
  22 #include "canvas/rectangle.h"
  23 #include "canvas/wave_view.h"
  24 #include "canvas/debug.h"
  25
  26 #include "ardour_ui.h"
  27 #include "automation_time_axis.h"
  28 #include "ghostregion.h"
  29 #include "midi_streamview.h"
  30 #include "midi_time_axis.h"
  31 #include "rgb_macros.h"
  32 #include "note.h"
  33
  34 using namespace std;
  35 using namespace Editing;
  36 using namespace ArdourCanvas;
  37 using namespace ARDOUR;
  38
  39 PBD::Signal1<void,GhostRegion*> GhostRegion::CatchDeletion;
  40
  41 GhostRegion::GhostRegion (ArdourCanvas::Container* parent, TimeAxisView& tv, TimeAxisView& source_tv, double initial_pos)
  42         : trackview (tv)
  43         , source_trackview (source_tv)
  44 {
  45         group = new ArdourCanvas::Container (parent);
  46         CANVAS_DEBUG_NAME (group, "ghost region");
  47         group->set_position (ArdourCanvas::Duple (initial_pos, 0));
  48
  49         base_rect = new ArdourCanvas::Rectangle (group);
  50         CANVAS_DEBUG_NAME (base_rect, "ghost region rect");
  51         base_rect->set_x0 (0);
  52         base_rect->set_y0 (0.0);
  53         base_rect->set_y1 (trackview.current_height() - 1.0);
  54         base_rect->set_outline_what (ArdourCanvas::Rectangle::What (0));
  55
  56         if (!is_automation_ghost()) {
  57                 base_rect->hide();
  58         }
  59
  60         GhostRegion::set_colors();
  61
  62         /* the parent group of a ghostregion is a dedicated group for ghosts,
  63            so the new ghost would want to get to the top of that group*/
  64         group->raise_to_top ();
  65 }
  66
  67 GhostRegion::~GhostRegion ()
  68 {
  69         CatchDeletion (this);
  70         delete base_rect;
  71         delete group;
  72 }
  73
  74 void
  75 GhostRegion::set_duration (double units)
  76 {
  77         base_rect->set_x1 (units);
  78 }
  79
  80 void
  81 GhostRegion::set_height ()
  82 {
  83         base_rect->set_y1 (trackview.current_height());
  84 }
  85
  86 void
  87 GhostRegion::set_colors ()
  88 {
  89         if (is_automation_ghost()) {
  90                 base_rect->set_outline_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackBase());
  91                 base_rect->set_fill_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackBase());
  92         }
  93 }
  94
  95 guint
  96 GhostRegion::source_track_color(unsigned char alpha)
  97 {
  98         Gdk::Color color = source_trackview.color();
  99         return RGBA_TO_UINT (color.get_red() / 256, color.get_green() / 256, color.get_blue() / 256, alpha);
 100 }
 101
 102 bool
 103 GhostRegion::is_automation_ghost()
 104 {
 105         return (dynamic_cast<AutomationTimeAxisView*>(&trackview)) != 0;
 106 }
 107
 108 AudioGhostRegion::AudioGhostRegion(TimeAxisView& tv, TimeAxisView& source_tv, double initial_unit_pos)
 109         : GhostRegion(tv.ghost_group(), tv, source_tv, initial_unit_pos)
 110 {
 111
 112 }
 113
 114 void
 115 AudioGhostRegion::set_samples_per_pixel (double fpp)
 116 {
 117         for (vector<WaveView*>::iterator i = waves.begin(); i != waves.end(); ++i) {
 118                 (*i)->set_samples_per_pixel (fpp);
 119         }
 120 }
 121
 122 void
 123 AudioGhostRegion::set_height ()
 124 {
 125         vector<WaveView*>::iterator i;
 126         uint32_t n;
 127
 128         GhostRegion::set_height();
 129
 130         double const ht = ((trackview.current_height()) / (double) waves.size());
 131
 132         for (n = 0, i = waves.begin(); i != waves.end(); ++i, ++n) {
 133                 (*i)->set_height (ht);
 134                 (*i)->set_y_position (n * ht);
 135         }
 136 }
 137
 138 void
 139 AudioGhostRegion::set_colors ()
 140 {
 141         GhostRegion::set_colors();
 142         guint fill_color;
 143
 144         if (is_automation_ghost()) {
 145                 fill_color = ARDOUR_UI::config()->get_canvasvar_GhostTrackWaveFill();
 146         }
 147         else {
 148                 fill_color = source_track_color(200);
 149         }
 150
 151         for (uint32_t n=0; n < waves.size(); ++n) {
 152                 waves[n]->set_outline_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackWave());
 153                 waves[n]->set_fill_color (fill_color);
 154                 waves[n]->set_clip_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackWaveClip());
 155                 waves[n]->set_zero_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackZeroLine());
 156         }
 157 }
 158
 159 /** The general constructor; called when the destination timeaxisview doesn't have
 160  *  a midistreamview.
 161  *
 162  *  @param tv TimeAxisView that this ghost region is on.
 163  *  @param source_tv TimeAxisView that we are the ghost for.
 164  */
 165 MidiGhostRegion::MidiGhostRegion(TimeAxisView& tv, TimeAxisView& source_tv, double initial_unit_pos)
 166         : GhostRegion(tv.ghost_group(), tv, source_tv, initial_unit_pos)
 167         , _optimization_iterator (events.end ())
 168 {
 169         base_rect->lower_to_bottom();
 170         update_range ();
 171
 172         midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
 173 }
 174
 175 /**
 176  *  @param msv MidiStreamView that this ghost region is on.
 177  *  @param source_tv TimeAxisView that we are the ghost for.
 178  */
 179 MidiGhostRegion::MidiGhostRegion(MidiStreamView& msv, TimeAxisView& source_tv, double initial_unit_pos)
 180         : GhostRegion(msv.midi_underlay_group, msv.trackview(), source_tv, initial_unit_pos)
 181         , _optimization_iterator (events.end ())
 182 {
 183         base_rect->lower_to_bottom();
 184         update_range ();
 185
 186         midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
 187 }
 188
 189 MidiGhostRegion::~MidiGhostRegion()
 190 {
 191         clear_events ();
 192 }
 193
 194 MidiGhostRegion::GhostEvent::GhostEvent (NoteBase* e, ArdourCanvas::Container* g)
 195         : event (e)
 196 {
 197         rect = new ArdourCanvas::Rectangle (g, ArdourCanvas::Rect (e->x0(), e->y0(), e->x1(), e->y1()));
 198         CANVAS_DEBUG_NAME (rect, "ghost note rect");
 199 }
 200
 201 MidiGhostRegion::GhostEvent::~GhostEvent ()
 202 {
 203         /* event is not ours to delete */
 204         delete rect;
 205 }
 206
 207 void
 208 MidiGhostRegion::set_samples_per_pixel (double /*spu*/)
 209 {
 210 }
 211
 212 /** @return MidiStreamView that we are providing a ghost for */
 213 MidiStreamView*
 214 MidiGhostRegion::midi_view ()
 215 {
 216         StreamView* sv = source_trackview.view ();
 217         assert (sv);
 218         MidiStreamView* msv = dynamic_cast<MidiStreamView*> (sv);
 219         assert (msv);
 220
 221         return msv;
 222 }
 223
 224 void
 225 MidiGhostRegion::set_height ()
 226 {
 227         GhostRegion::set_height();
 228         update_range();
 229 }
 230
 231 void
 232 MidiGhostRegion::set_colors()
 233 {
 234         guint fill = source_track_color(200);
 235
 236         GhostRegion::set_colors();
 237
 238         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 239                 (*it)->rect->set_fill_color (fill);
 240                 (*it)->rect->set_outline_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackMidiOutline());
 241         }
 242 }
 243
 244 void
 245 MidiGhostRegion::update_range ()
 246 {
 247         MidiStreamView* mv = midi_view();
 248
 249         if (!mv) {
 250                 return;
 251         }
 252
 253         double const h = std::max(1., floor (trackview.current_height() / double (mv->contents_note_range ())) -1);
 254         double const s = trackview.current_height() / double (mv->contents_note_range ());
 255
 256         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 257                 uint8_t const note_num = (*it)->event->note()->note();
 258
 259                 if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
 260                         (*it)->rect->hide();
 261                 } else {
 262                         (*it)->rect->show();
 263                         double const y = trackview.current_height() - (note_num + 1 - mv->lowest_note()) * s;
 264                         (*it)->rect->set_y0 (y);
 265                         (*it)->rect->set_y1 (y + h);
 266                 }
 267         }
 268 }
 269
 270 void
 271 MidiGhostRegion::add_note (NoteBase* n)
 272 {
 273         GhostEvent* event = new GhostEvent (n, group);
 274         events.push_back (event);
 275
 276         event->rect->set_fill_color (source_track_color(200));
 277         event->rect->set_outline_color (ARDOUR_UI::config()->get_canvasvar_GhostTrackMidiOutline());
 278
 279         MidiStreamView* mv = midi_view();
 280
 281         if (mv) {
 282                 const uint8_t note_num = n->note()->note();
 283
 284                 if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
 285                         event->rect->hide();
 286                 } else {
 287                         const double y = mv->note_to_y(note_num);
 288                         event->rect->set_y0 (y);
 289                         event->rect->set_y1 (y + std::max(1., floor(mv->note_height()) -1));
 290                 }
 291         }
 292 }
 293
 294 void
 295 MidiGhostRegion::clear_events()
 296 {
 297         for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
 298                 delete *it;
 299         }
 300
 301         events.clear();
 302         _optimization_iterator = events.end ();
 303 }
 304
 305 /** Update the x positions of our representation of a parent's note.
 306  *  @param parent The CanvasNote from the parent MidiRegionView.
 307  */
 308 void
 309 MidiGhostRegion::update_note (NoteBase* parent)
 310 {
 311         GhostEvent* ev = find_event (parent);
 312         if (!ev) {
 313                 return;
 314         }
 315
 316         double const x1 = parent->x0 ();
 317         double const x2 = parent->x1 ();
 318         ev->rect->set_x0 (x1);
 319         ev->rect->set_x1 (x2);
 320 }
 321
 322 void
 323 MidiGhostRegion::remove_note (NoteBase* note)
 324 {
 325         GhostEvent* ev = find_event (note);
 326         if (!ev) {
 327                 return;
 328         }
 329
 330         events.remove (ev);
 331         delete ev;
 332         _optimization_iterator = events.end ();
 333 }
 334
 335 /** Given a note in our parent region (ie the actual MidiRegionView), find our
 336  *  representation of it.
 337  *  @return Our Event, or 0 if not found.
 338  */
 339
 340 MidiGhostRegion::GhostEvent *
 341 MidiGhostRegion::find_event (NoteBase* parent)
 342 {
 343         /* we are using _optimization_iterator to speed up the common case where a caller
 344            is going through our notes in order.
 345         */
 346
 347         if (_optimization_iterator != events.end()) {
 348                 ++_optimization_iterator;
 349         }
 350
 351         if (_optimization_iterator != events.end() && (*_optimization_iterator)->event == parent) {
 352                 return *_optimization_iterator;
 353         }
 354
 355         for (_optimization_iterator = events.begin(); _optimization_iterator != events.end(); ++_optimization_iterator) {
 356                 if ((*_optimization_iterator)->event == parent) {
 357                         return *_optimization_iterator;
 358                 }
 359         }
 360
 361         return 0;
 362 }