ardour/gtk2_ardour/ghostregion.cc
Tim Mayberry b074ff0dd5 Remove GhostRegion::CatchDeletion signal to reduce session close times
Currently when a GhostRegion is deleted by its "parent" RegionView it emits the
static GhostRegion::CatchDeletion signal which is connected to the
RegionView::remove_ghost method of every RegionView instance.

With a static GhostRegion::CatchDeletion signal a particular test session
causes 31 Million calls of RegionView::remove_ghost on Session deletion and the
session takes 70 seconds to close with a debug build.

The lifetime of a ghost region is tied to both the TimeAxisView(TAV) and
RegionView(RV) in that when a RegionView is deleted all GhostRegion instances
associated with the RegionView should be deleted or when a TimeAxisView is
deleted all ghost regions that are contained in the view should be deleted.

This means that there needs to be notification between GhostRegion and both
classes. Instead of using a signal for this as we know there are only two
listeners and GhostRegion already holds a reference to the TimeAxisView, also
take a reference to the parent RegionView in the GhostRegion constructor and
use it to notify the RegionView when GhostRegion destructor is called so it can
drop any references it holds.

Using a direct function call in the GhostRegion destructor to notify the
TimeAxisView and RegionView "parents" brings the unload/close time down for the
test session from 70 seconds to 4.5 seconds.

The GhostRegion also references canvas items that are added to the TimeAxisView
canvas group or at least a canvas group that it manages. So when the
TimeAxisView is destroyed and the canvas group that is the parent of those
items is destroyed, the GhostRegion's canvas items will also be
deleted/destroyed by the parent canvas item/group. This means the GhostRegions
must be destroyed when the TimeAxisView they are contained in is destroyed or
there will be dangling references to canvas items that have already been
deleted and trying to delete them again will be bad.
2015-10-22 11:51:03 -04:00

446 lines
12 KiB
C++

/*
Copyright (C) 2000-2007 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include "ardour/parameter_descriptor.h"
#include "evoral/Note.hpp"
#include "canvas/container.h"
#include "canvas/polygon.h"
#include "canvas/rectangle.h"
#include "canvas/wave_view.h"
#include "canvas/debug.h"
#include "automation_time_axis.h"
#include "ghostregion.h"
#include "midi_streamview.h"
#include "midi_time_axis.h"
#include "region_view.h"
#include "rgb_macros.h"
#include "note.h"
#include "hit.h"
#include "ui_config.h"
using namespace std;
using namespace Editing;
using namespace ArdourCanvas;
using namespace ARDOUR;
GhostRegion::GhostRegion(RegionView& rv,
ArdourCanvas::Container* parent,
TimeAxisView& tv,
TimeAxisView& source_tv,
double initial_pos)
: parent_rv(rv)
, trackview(tv)
, source_trackview(source_tv)
{
group = new ArdourCanvas::Container (parent);
CANVAS_DEBUG_NAME (group, "ghost region");
group->set_position (ArdourCanvas::Duple (initial_pos, 0));
base_rect = new ArdourCanvas::Rectangle (group);
CANVAS_DEBUG_NAME (base_rect, "ghost region rect");
base_rect->set_x0 (0);
base_rect->set_y0 (1.0);
base_rect->set_y1 (trackview.current_height());
base_rect->set_outline (false);
if (!is_automation_ghost()) {
base_rect->hide();
}
GhostRegion::set_colors();
/* the parent group of a ghostregion is a dedicated group for ghosts,
so the new ghost would want to get to the top of that group*/
group->raise_to_top ();
}
GhostRegion::~GhostRegion ()
{
parent_rv.remove_ghost(this);
trackview.erase_ghost(this);
delete base_rect;
delete group;
}
void
GhostRegion::set_duration (double units)
{
base_rect->set_x1 (units);
}
void
GhostRegion::set_height ()
{
base_rect->set_y1 (trackview.current_height());
}
void
GhostRegion::set_colors ()
{
if (is_automation_ghost()) {
base_rect->set_fill_color (UIConfiguration::instance().color_mod ("ghost track base", "ghost track base"));
}
}
guint
GhostRegion::source_track_color(unsigned char alpha)
{
Gdk::Color color = source_trackview.color();
return RGBA_TO_UINT (color.get_red() / 256, color.get_green() / 256, color.get_blue() / 256, alpha);
}
bool
GhostRegion::is_automation_ghost()
{
return (dynamic_cast<AutomationTimeAxisView*>(&trackview)) != 0;
}
AudioGhostRegion::AudioGhostRegion(RegionView& rv,
TimeAxisView& tv,
TimeAxisView& source_tv,
double initial_unit_pos)
: GhostRegion(rv, tv.ghost_group(), tv, source_tv, initial_unit_pos)
{
}
void
AudioGhostRegion::set_samples_per_pixel (double fpp)
{
for (vector<WaveView*>::iterator i = waves.begin(); i != waves.end(); ++i) {
(*i)->set_samples_per_pixel (fpp);
}
}
void
AudioGhostRegion::set_height ()
{
vector<WaveView*>::iterator i;
uint32_t n;
GhostRegion::set_height();
double const ht = ((trackview.current_height()) / (double) waves.size());
for (n = 0, i = waves.begin(); i != waves.end(); ++i, ++n) {
(*i)->set_height (ht);
(*i)->set_y_position (n * ht);
}
}
void
AudioGhostRegion::set_colors ()
{
GhostRegion::set_colors();
guint fill_color;
if (is_automation_ghost()) {
fill_color = UIConfiguration::instance().color ("ghost track wave fill");
}
else {
fill_color = source_track_color(200);
}
for (uint32_t n=0; n < waves.size(); ++n) {
waves[n]->set_outline_color (UIConfiguration::instance().color ("ghost track wave"));
waves[n]->set_fill_color (fill_color);
waves[n]->set_clip_color (UIConfiguration::instance().color ("ghost track wave clip"));
waves[n]->set_zero_color (UIConfiguration::instance().color ("ghost track zero line"));
}
}
/** The general constructor; called when the destination timeaxisview doesn't have
* a midistreamview.
*
* @param rv The parent RegionView that is being ghosted.
* @param tv TimeAxisView that this ghost region is on.
* @param source_tv TimeAxisView that we are the ghost for.
*/
MidiGhostRegion::MidiGhostRegion(RegionView& rv,
TimeAxisView& tv,
TimeAxisView& source_tv,
double initial_unit_pos)
: GhostRegion(rv, tv.ghost_group(), tv, source_tv, initial_unit_pos)
, _optimization_iterator(events.end())
{
base_rect->lower_to_bottom();
update_range ();
midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
}
/**
* @param rv The parent RegionView being ghosted.
* @param msv MidiStreamView that this ghost region is on.
* @param source_tv TimeAxisView that we are the ghost for.
*/
MidiGhostRegion::MidiGhostRegion(RegionView& rv,
MidiStreamView& msv,
TimeAxisView& source_tv,
double initial_unit_pos)
: GhostRegion(rv,
msv.midi_underlay_group,
msv.trackview(),
source_tv,
initial_unit_pos)
, _optimization_iterator(events.end())
{
base_rect->lower_to_bottom();
update_range ();
midi_view()->NoteRangeChanged.connect (sigc::mem_fun (*this, &MidiGhostRegion::update_range));
}
MidiGhostRegion::~MidiGhostRegion()
{
clear_events ();
}
MidiGhostRegion::GhostEvent::GhostEvent (NoteBase* e, ArdourCanvas::Container* g)
: event (e)
{
Hit* hit = NULL;
if (dynamic_cast<Note*>(e)) {
item = new ArdourCanvas::Rectangle(
g, ArdourCanvas::Rect(e->x0(), e->y0(), e->x1(), e->y1()));
} else if ((hit = dynamic_cast<Hit*>(e))) {
ArdourCanvas::Polygon* poly = new ArdourCanvas::Polygon(g);
poly->set(Hit::points(e->y1() - e->y0()));
poly->set_position(hit->position());
item = poly;
}
CANVAS_DEBUG_NAME (item, "ghost note item");
}
MidiGhostRegion::GhostEvent::~GhostEvent ()
{
/* event is not ours to delete */
delete item;
}
void
MidiGhostRegion::set_samples_per_pixel (double /*spu*/)
{
}
/** @return MidiStreamView that we are providing a ghost for */
MidiStreamView*
MidiGhostRegion::midi_view ()
{
StreamView* sv = source_trackview.view ();
assert (sv);
MidiStreamView* msv = dynamic_cast<MidiStreamView*> (sv);
assert (msv);
return msv;
}
void
MidiGhostRegion::set_height ()
{
GhostRegion::set_height();
update_range();
}
void
MidiGhostRegion::set_colors()
{
GhostRegion::set_colors();
for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
(*it)->item->set_fill_color (UIConfiguration::instance().color_mod((*it)->event->base_color(), "ghost track midi fill"));
(*it)->item->set_outline_color (UIConfiguration::instance().color ("ghost track midi outline"));
}
}
static double
note_height(TimeAxisView& trackview, MidiStreamView* mv)
{
const double tv_height = trackview.current_height();
const double note_range = mv->contents_note_range();
return std::max(1.0, floor(tv_height / note_range - 1.0));
}
static double
note_y(TimeAxisView& trackview, MidiStreamView* mv, uint8_t note_num)
{
const double tv_height = trackview.current_height();
const double note_range = mv->contents_note_range();
const double s = tv_height / note_range;
return tv_height - (note_num + 1 - mv->lowest_note()) * s;
}
void
MidiGhostRegion::update_range ()
{
MidiStreamView* mv = midi_view();
if (!mv) {
return;
}
double const h = note_height(trackview, mv);
for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
uint8_t const note_num = (*it)->event->note()->note();
if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
(*it)->item->hide();
} else {
(*it)->item->show();
double const y = note_y(trackview, mv, note_num);
ArdourCanvas::Rectangle* rect = NULL;
ArdourCanvas::Polygon* poly = NULL;
if ((rect = dynamic_cast<ArdourCanvas::Rectangle*>((*it)->item))) {
rect->set_y0 (y);
rect->set_y1 (y + h);
} else if ((poly = dynamic_cast<ArdourCanvas::Polygon*>((*it)->item))) {
Duple position = poly->position();
position.y = y;
poly->set_position(position);
poly->set(Hit::points(h));
}
}
}
}
void
MidiGhostRegion::add_note (NoteBase* n)
{
GhostEvent* event = new GhostEvent (n, group);
events.push_back (event);
event->item->set_fill_color (UIConfiguration::instance().color_mod(n->base_color(), "ghost track midi fill"));
event->item->set_outline_color (UIConfiguration::instance().color ("ghost track midi outline"));
MidiStreamView* mv = midi_view();
if (mv) {
uint8_t const note_num = n->note()->note();
double const h = note_height(trackview, mv);
double const y = note_y(trackview, mv, note_num);
if (note_num < mv->lowest_note() || note_num > mv->highest_note()) {
event->item->hide();
} else {
ArdourCanvas::Rectangle* rect = NULL;
ArdourCanvas::Polygon* poly = NULL;
if ((rect = dynamic_cast<ArdourCanvas::Rectangle*>(event->item))) {
rect->set_y0 (y);
rect->set_y1 (y + h);
} else if ((poly = dynamic_cast<ArdourCanvas::Polygon*>(event->item))) {
Duple position = poly->position();
position.y = y;
poly->set_position(position);
poly->set(Hit::points(h));
}
}
}
}
void
MidiGhostRegion::clear_events()
{
for (EventList::iterator it = events.begin(); it != events.end(); ++it) {
delete *it;
}
events.clear();
_optimization_iterator = events.end ();
}
/** Update the x positions of our representation of a parent's note.
* @param parent The CanvasNote from the parent MidiRegionView.
*/
void
MidiGhostRegion::update_note (NoteBase* parent)
{
GhostEvent* ev = find_event (parent);
if (!ev) {
return;
}
Note* note = NULL;
ArdourCanvas::Rectangle* rect = NULL;
Hit* hit = NULL;
ArdourCanvas::Polygon* poly = NULL;
if ((note = dynamic_cast<Note*>(parent))) {
if ((rect = dynamic_cast<ArdourCanvas::Rectangle*>(ev->item))) {
double const x1 = parent->x0 ();
double const x2 = parent->x1 ();
rect->set_x0 (x1);
rect->set_x1 (x2);
}
} else if ((hit = dynamic_cast<Hit*>(parent))) {
if ((poly = dynamic_cast<ArdourCanvas::Polygon*>(ev->item))) {
ArdourCanvas::Duple ppos = hit->position();
ArdourCanvas::Duple gpos = poly->position();
gpos.x = ppos.x;
poly->set_position(gpos);
}
}
}
void
MidiGhostRegion::remove_note (NoteBase* note)
{
GhostEvent* ev = find_event (note);
if (!ev) {
return;
}
events.remove (ev);
delete ev;
_optimization_iterator = events.end ();
}
/** Given a note in our parent region (ie the actual MidiRegionView), find our
* representation of it.
* @return Our Event, or 0 if not found.
*/
MidiGhostRegion::GhostEvent *
MidiGhostRegion::find_event (NoteBase* parent)
{
/* we are using _optimization_iterator to speed up the common case where a caller
is going through our notes in order.
*/
if (_optimization_iterator != events.end()) {
++_optimization_iterator;
}
if (_optimization_iterator != events.end() && (*_optimization_iterator)->event == parent) {
return *_optimization_iterator;
}
for (_optimization_iterator = events.begin(); _optimization_iterator != events.end(); ++_optimization_iterator) {
if ((*_optimization_iterator)->event == parent) {
return *_optimization_iterator;
}
}
return 0;
}