ardour/gtk2_ardour/port_matrix_grid.cc

/*
    Copyright (C) 2002-2009 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 <iostream>
#include <cairo/cairo.h>
#include "ardour/bundle.h"
#include "ardour/types.h"
#include "port_matrix_grid.h"
#include "port_matrix.h"
#include "port_matrix_body.h"

using namespace std;

PortMatrixGrid::PortMatrixGrid (PortMatrix* m, PortMatrixBody* b)
	: PortMatrixComponent (m, b)
{
	
}

void
PortMatrixGrid::compute_dimensions ()
{
	_width = 0;
	for (PortGroupList::List::const_iterator i = _matrix->columns()->begin(); i != _matrix->columns()->end(); ++i) {
		_width += group_width (*i);
	}

	_height = 0;
	for (PortGroupList::List::const_iterator i = _matrix->rows()->begin(); i != _matrix->rows()->end(); ++i) {
		_height += group_height (*i);
	}
}


void
PortMatrixGrid::render (cairo_t* cr)
{
	set_source_rgb (cr, background_colour());
	cairo_rectangle (cr, 0, 0, _width, _height);
	cairo_fill (cr);

	uint32_t x = 0;
	for (PortGroupList::List::const_iterator c = _matrix->columns()->begin(); c != _matrix->columns()->end(); ++c) {

		uint32_t y = 0;
		for (PortGroupList::List::const_iterator r = _matrix->rows()->begin(); r != _matrix->rows()->end(); ++r) {

			if ((*c)->visible() && (*r)->visible()) {
				render_group_pair (cr, *r, *c, x, y);
			}

			y += group_height (*r);
		}

		x += group_width (*c);
	}
}

void
PortMatrixGrid::render_group_pair (cairo_t* cr, boost::shared_ptr<const PortGroup> row, boost::shared_ptr<const PortGroup> column, uint32_t const x, uint32_t const y)
{
	PortGroup::BundleList const & row_bundles = row->bundles();
	PortGroup::BundleList const & column_bundles = column->bundles();

	/* unfortunately we need to compute the height of the row group here */
	uint32_t height = group_height (row);
	
	uint32_t tx = x;

	/* VERTICAL GRID LINES */
	
	set_source_rgb (cr, grid_colour());
	uint32_t N = 0;
	
	for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {

		cairo_set_line_width (cr, thick_grid_line_width());
		cairo_move_to (cr, tx, y);
		cairo_line_to (cr, tx, y + height);
		cairo_stroke (cr);
		
		if (!_matrix->show_only_bundles()) {
			cairo_set_line_width (cr, thin_grid_line_width());
			for (uint32_t j = 0; j < i->bundle->nchannels(); ++j) {
				tx += column_width ();
				cairo_move_to (cr, tx, y);
				cairo_line_to (cr, tx, y + height);
				cairo_stroke (cr);
			}
			
		} else {
			
			tx += column_width ();
			
		}
		
		++N;
	}

 	uint32_t const width = tx - x;

	uint32_t ty = y;
	
	/* HORIZONTAL GRID LINES */
	
	N = 0;
	for (PortGroup::BundleList::const_iterator i = row_bundles.begin(); i != row_bundles.end(); ++i) {
		
		cairo_set_line_width (cr, thick_grid_line_width());
		cairo_move_to (cr, x, ty);
		cairo_line_to (cr, x + width, ty);
		cairo_stroke (cr);
		
		if (!_matrix->show_only_bundles()) {
			cairo_set_line_width (cr, thin_grid_line_width());
			for (uint32_t j = 0; j < i->bundle->nchannels(); ++j) {
				ty += row_height ();
				cairo_move_to (cr, x, ty);
				cairo_line_to (cr, x + width, ty);
				cairo_stroke (cr);
			}

		} else {

			ty += row_height ();

		}
		
		++N;
	}
	
	/* ASSOCIATION INDICATORS */

	uint32_t bx = x;
	uint32_t by = y;

	if (_matrix->show_only_bundles()) {

		for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {
			by = y;
			
			for (PortGroup::BundleList::const_iterator j = row_bundles.begin(); j != row_bundles.end(); ++j) {
				
				PortMatrixNode::State s = bundle_to_bundle_state (i->bundle, j->bundle);
				switch (s) {
				case PortMatrixNode::UNKNOWN:
					draw_unknown_indicator (cr, bx, by);
					break;
				case PortMatrixNode::ASSOCIATED:
					draw_association_indicator (cr, bx, by);
					break;
				case PortMatrixNode::PARTIAL:
					draw_association_indicator (cr, bx, by, 0.5);
					break;
				default:
					break;
				}
				
				by += row_height();
			}
			
			bx += column_width();
			
		}

	} else {

		for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {
			by = y;
			
			for (PortGroup::BundleList::const_iterator j = row_bundles.begin(); j != row_bundles.end(); ++j) {
				
				tx = bx;
				for (uint32_t k = 0; k < i->bundle->nchannels (); ++k) {
					
					ty = by;
					for (uint32_t l = 0; l < j->bundle->nchannels (); ++l) {
						
						ARDOUR::BundleChannel c[2];
						c[_matrix->column_index()] = ARDOUR::BundleChannel (i->bundle, k);
						c[_matrix->row_index()] = ARDOUR::BundleChannel (j->bundle, l);
						
						PortMatrixNode::State const s = _matrix->get_state (c);
						
						switch (s) {
						case PortMatrixNode::ASSOCIATED:
							draw_association_indicator (cr, tx, ty);
							break;
							
						case PortMatrixNode::UNKNOWN:
							draw_unknown_indicator (cr, tx, ty);
							break;
							
						case PortMatrixNode::NOT_ASSOCIATED:
							break;
							
						default:
							break;
						}
						
						ty += row_height();
					}
					
					tx += column_width();
				}
				
				by += j->bundle->nchannels () * row_height();
			}
			
			bx += i->bundle->nchannels () * column_width();
		}
	}
}

void
PortMatrixGrid::draw_association_indicator (cairo_t* cr, uint32_t x, uint32_t y, double p)
{
	set_source_rgba (cr, association_colour(), 0.5);
	cairo_arc (
		cr,
		x + column_width() / 2,
		y + column_width() / 2,
		(column_width() - (2 * connection_indicator_pad())) / 2,
		0,
		p * 2 * M_PI
		);
	
	cairo_fill (cr);
}

void
PortMatrixGrid::draw_unknown_indicator (cairo_t* cr, uint32_t x, uint32_t y)
{
	set_source_rgba (cr, unknown_colour(), 0.5);
	cairo_rectangle (
		cr,
		x + thick_grid_line_width(),
		y + thick_grid_line_width(),
		column_width() - 2 * thick_grid_line_width(),
		row_height() - 2 * thick_grid_line_width()
		);
	cairo_fill (cr);
}

PortMatrixNode
PortMatrixGrid::position_to_node (double x, double y) const
{
	return PortMatrixNode (
		y_position_to_group_and_channel (y).second,
		x_position_to_group_and_channel (x).second
		);
}


pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel>
PortMatrixGrid::x_position_to_group_and_channel (double x) const
{
	PortGroupList::List::const_iterator i = _matrix->columns()->begin();

	while (i != _matrix->columns()->end()) {

		uint32_t const gw = group_width (*i);

		if (x < gw) {

			/* it's in this group */

			PortGroup::BundleList const & bundles = (*i)->bundles ();
			for (PortGroup::BundleList::const_iterator j = bundles.begin(); j != bundles.end(); ++j) {

				if (_matrix->show_only_bundles()) {
					
					if (x < column_width()) {
						return make_pair (*i, ARDOUR::BundleChannel (j->bundle, 0));
					} else {
						x -= column_width ();
					}
					
				} else {

					uint32_t const w = j->bundle->nchannels () * column_width ();
					if (x < w) {
						return make_pair (*i, ARDOUR::BundleChannel (j->bundle, x / column_width()));
					} else {
						x -= w;
					}

				}

			}

		} else {

			x -= gw;

		}

		++i;
	}

	return make_pair (boost::shared_ptr<PortGroup> (), ARDOUR::BundleChannel (boost::shared_ptr<ARDOUR::Bundle> (), 0));
}



double
PortMatrixGrid::channel_position (
	ARDOUR::BundleChannel bc,
	PortGroup::BundleList const& bundles,
	double inc) const
{
	double p = 0;
	
	PortGroup::BundleList::const_iterator i = bundles.begin ();
	while (i != bundles.end() && i->bundle != bc.bundle) {

		if (_matrix->show_only_bundles()) {
			p += inc;
		} else {
			p += inc * i->bundle->nchannels();
		}
		
		++i;
	}

	if (i == bundles.end()) {
		return 0;
	}

	p += inc * bc.channel;

	return p;
}

void
PortMatrixGrid::button_press (double x, double y, int b, uint32_t t)
{
	if (b == 1) {
		
		PortMatrixNode const node = position_to_node (x, y);
		
		if (_matrix->show_only_bundles()) {
			
			PortMatrixNode::State const s = bundle_to_bundle_state (node.column.bundle, node.row.bundle);
			
			for (uint32_t i = 0; i < node.column.bundle->nchannels(); ++i) {
				for (uint32_t j = 0; j < node.row.bundle->nchannels(); ++j) {
					
					ARDOUR::BundleChannel c[2];
					c[_matrix->column_index()] = ARDOUR::BundleChannel (node.column.bundle, i);
					c[_matrix->row_index()] = ARDOUR::BundleChannel (node.row.bundle, j);
					if (s == PortMatrixNode::NOT_ASSOCIATED || s == PortMatrixNode::PARTIAL) {
						_matrix->set_state (c, i == j);
					} else {
						_matrix->set_state (c, false);
					}
				}
			}
			
		} else {
			
			if (node.row.bundle && node.column.bundle) {
				
				ARDOUR::BundleChannel c[2];
				c[_matrix->row_index()] = node.row;
				c[_matrix->column_index()] = node.column;
				
				PortMatrixNode::State const s = _matrix->get_state (c);
				
				if (s == PortMatrixNode::ASSOCIATED || s == PortMatrixNode::NOT_ASSOCIATED) {
					
					bool const n = !(s == PortMatrixNode::ASSOCIATED);
					
					ARDOUR::BundleChannel c[2];
					c[_matrix->row_index()] = node.row;
					c[_matrix->column_index()] = node.column;
					
					_matrix->set_state (c, n);
				}
				
			}
		}
		
		require_render ();
		_body->queue_draw ();

	} else if (b == 3) {

		_matrix->popup_menu (x_position_to_group_and_channel (x), y_position_to_group_and_channel (y), t);
		
	}
}

void
PortMatrixGrid::draw_extra (cairo_t* cr)
{
	set_source_rgba (cr, mouseover_line_colour(), 0.3);
	cairo_set_line_width (cr, mouseover_line_width());

	double const x = component_to_parent_x (
		channel_position (_body->mouseover().column, _matrix->columns()->bundles(), column_width()) + column_width() / 2
		);
	
	double const y = component_to_parent_y (
		channel_position (_body->mouseover().row, _matrix->rows()->bundles(), row_height()) + row_height() / 2
		);
	
	if (_body->mouseover().row.bundle) {

		cairo_move_to (cr, x, y);
		if (_matrix->arrangement() == PortMatrix::LEFT_TO_BOTTOM) {
			cairo_line_to (cr, component_to_parent_x (0), y);
		} else if (_matrix->arrangement() == PortMatrix::TOP_TO_RIGHT) {
			cairo_line_to (cr, _parent_rectangle.get_x() + _parent_rectangle.get_width(), y);
		}
		cairo_stroke (cr);
	}

	if (_body->mouseover().column.bundle) {

		cairo_move_to (cr, x, y);
		if (_matrix->arrangement() == PortMatrix::LEFT_TO_BOTTOM) {
			cairo_line_to (cr, x, _parent_rectangle.get_y() + _parent_rectangle.get_height());
		} else if (_matrix->arrangement() == PortMatrix::TOP_TO_RIGHT) {
			cairo_line_to (cr, x, component_to_parent_y (0));
		}
		cairo_stroke (cr);
	}
}

void
PortMatrixGrid::mouseover_changed (PortMatrixNode const& old)
{
	queue_draw_for (old);
	queue_draw_for (_body->mouseover());
}

void
PortMatrixGrid::mouseover_event (double x, double y)
{
	_body->set_mouseover (position_to_node (x, y));
}

void
PortMatrixGrid::queue_draw_for (PortMatrixNode const &n)
{
	if (n.row.bundle) {

		double const y = channel_position (n.row, _matrix->rows()->bundles(), row_height());
		_body->queue_draw_area (
			_parent_rectangle.get_x(),
			component_to_parent_y (y),
			_parent_rectangle.get_width(),
			row_height()
			);
	}

	if (n.column.bundle) {

		double const x = channel_position (n.column, _matrix->columns()->bundles(), column_width());
		
		_body->queue_draw_area (
			component_to_parent_x (x),
			_parent_rectangle.get_y(),
			column_width(),
			_parent_rectangle.get_height()
			);
	}
}

double
PortMatrixGrid::component_to_parent_x (double x) const
{
	return x - _body->xoffset() + _parent_rectangle.get_x();
}

double
PortMatrixGrid::parent_to_component_x (double x) const
{
	return x + _body->xoffset() - _parent_rectangle.get_x();
}

double
PortMatrixGrid::component_to_parent_y (double y) const
{
	return y - _body->yoffset() + _parent_rectangle.get_y();
}

double
PortMatrixGrid::parent_to_component_y (double y) const
{
	return y + _body->yoffset() - _parent_rectangle.get_y();
}

PortMatrixNode::State
PortMatrixGrid::bundle_to_bundle_state (boost::shared_ptr<ARDOUR::Bundle> a, boost::shared_ptr<ARDOUR::Bundle> b) const
{
	bool have_unknown = false;
	bool have_off_diagonal_association = false;
	bool have_diagonal_association = false;
	bool have_diagonal_not_association = false;
				
	for (uint32_t i = 0; i < a->nchannels (); ++i) {
					
		for (uint32_t j = 0; j < b->nchannels (); ++j) {
						
			ARDOUR::BundleChannel c[2];
			c[_matrix->column_index()] = ARDOUR::BundleChannel (a, i);
			c[_matrix->row_index()] = ARDOUR::BundleChannel (b, j);
			
			PortMatrixNode::State const s = _matrix->get_state (c);

			switch (s) {
			case PortMatrixNode::ASSOCIATED:
				if (i == j) {
					have_diagonal_association = true;
				} else {
					have_off_diagonal_association = true;
				}
				break;
				
			case PortMatrixNode::UNKNOWN:
				have_unknown = true;
				break;
				
			case PortMatrixNode::NOT_ASSOCIATED:
				if (i == j) {
					have_diagonal_not_association = true;
				}
				break;

			default:
				break;
			}
		}
	}
	
	if (have_unknown) {
		return PortMatrixNode::UNKNOWN;
	} else if (have_diagonal_association && !have_off_diagonal_association && !have_diagonal_not_association) {
		return PortMatrixNode::ASSOCIATED;
	} else if (!have_diagonal_association && !have_off_diagonal_association) {
		return PortMatrixNode::NOT_ASSOCIATED;
	}

	return PortMatrixNode::PARTIAL;
}