ardour/gtk2_ardour/midi_region_view.cc

/*
    Copyright (C) 2001-2007 Paul Davis 
    Author: Dave Robillard

    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 <cmath>
#include <cassert>
#include <algorithm>

#include <gtkmm.h>

#include <gtkmm2ext/gtk_ui.h>

#include <sigc++/signal.h>

#include <ardour/playlist.h>
#include <ardour/tempo.h>
#include <ardour/midi_region.h>
#include <ardour/midi_source.h>
#include <ardour/midi_diskstream.h>
#include <ardour/midi_events.h>
#include <ardour/midi_model.h>

#include "streamview.h"
#include "midi_region_view.h"
#include "midi_streamview.h"
#include "midi_time_axis.h"
#include "simplerect.h"
#include "simpleline.h"
#include "canvas-hit.h"
#include "public_editor.h"
#include "ghostregion.h"
#include "midi_time_axis.h"
#include "automation_time_axis.h"
#include "automation_region_view.h"
#include "utils.h"
#include "midi_util.h"
#include "gui_thread.h"
#include "keyboard.h"

#include "i18n.h"

using namespace sigc;
using namespace ARDOUR;
using namespace PBD;
using namespace Editing;
using namespace ArdourCanvas;

MidiRegionView::MidiRegionView (ArdourCanvas::Group *parent, RouteTimeAxisView &tv, boost::shared_ptr<MidiRegion> r, double spu, Gdk::Color& basic_color)
	: RegionView (parent, tv, r, spu, basic_color)
	, _default_note_length(0.0)
	, _active_notes(0)
	, _note_group(new ArdourCanvas::Group(*parent))
	, _delta_command(NULL)
	, _mouse_state(None)
	, _pressed_button(0)
{
	_note_group->raise_to_top();
}

MidiRegionView::MidiRegionView (ArdourCanvas::Group *parent, RouteTimeAxisView &tv, boost::shared_ptr<MidiRegion> r, double spu, Gdk::Color& basic_color, TimeAxisViewItem::Visibility visibility)
	: RegionView (parent, tv, r, spu, basic_color, visibility)
	, _default_note_length(0.0)
	, _active_notes(0)
	, _note_group(new ArdourCanvas::Group(*parent))
	, _delta_command(NULL)
	, _mouse_state(None)
	, _pressed_button(0)
{
	_note_group->raise_to_top();
}

void
MidiRegionView::init (Gdk::Color& basic_color, bool wfd)
{
	if (wfd)
		midi_region()->midi_source(0)->load_model();
	
	const Meter& m = trackview.session().tempo_map().meter_at(_region->position());
	const Tempo& t = trackview.session().tempo_map().tempo_at(_region->position());
	_default_note_length = m.frames_per_bar(t, trackview.session().frame_rate())
			/ m.beats_per_bar();

	_model = midi_region()->midi_source(0)->model();
	_enable_display = false;
	
	RegionView::init(basic_color, false);

	compute_colors (basic_color);

	reset_width_dependent_items ((double) _region->length() / samples_per_unit);

	set_y_position_and_height (0, trackview.height);

	region_muted ();
	region_resized (BoundsChanged);
	region_locked ();

	_region->StateChanged.connect (mem_fun(*this, &MidiRegionView::region_changed));

	set_colors ();

	_enable_display = true;

	if (_model) {
		if (wfd) {
			redisplay_model();
		}
		_model->ContentsChanged.connect(sigc::mem_fun(this, &MidiRegionView::redisplay_model));
	}

	midi_region()->midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegionView::switch_source));
	
	group->signal_event().connect (mem_fun (this, &MidiRegionView::canvas_event), false);

}

bool
MidiRegionView::canvas_event(GdkEvent* ev)
{
	static bool delete_mod = false;
	static Editing::MidiEditMode original_mode;

	static double drag_start_x, drag_start_y;
	static double last_x, last_y;
	double event_x, event_y;
	nframes_t event_frame = 0;

	static ArdourCanvas::SimpleRect* drag_rect = NULL;
	
	if (trackview.editor.current_mouse_mode() != MouseNote)
		return false;

	// Mmmm, spaghetti
	
	switch (ev->type) {
	case GDK_KEY_PRESS:
		if (ev->key.keyval == GDK_Delete && !delete_mod) {
			delete_mod = true;
			original_mode = trackview.editor.current_midi_edit_mode();
			trackview.editor.set_midi_edit_mode(MidiEditErase);
			start_remove_command();
			_mouse_state = EraseTouchDragging;
		} else if (ev->key.keyval == GDK_Shift_L || ev->key.keyval == GDK_Control_L) {
			_mouse_state = SelectTouchDragging;
		}
		return true;
	
	case GDK_KEY_RELEASE:
		if (ev->key.keyval == GDK_Delete) {
			if (_mouse_state == EraseTouchDragging) {
				delete_selection();
				apply_command();
			}
			if (delete_mod) {
				trackview.editor.set_midi_edit_mode(original_mode);
				delete_mod = false;
			}
		} else if (ev->key.keyval == GDK_Shift_L || ev->key.keyval == GDK_Control_L) {
			_mouse_state = None;
		}
		return true;

	case GDK_BUTTON_PRESS:
		if (_mouse_state != SelectTouchDragging && _mouse_state != EraseTouchDragging)
			_mouse_state = Pressed;
		_pressed_button = ev->button.button;
		return true;
	
	case GDK_ENTER_NOTIFY:
		/* FIXME: do this on switch to note tool, too, if the pointer is already in */
		Keyboard::magic_widget_grab_focus();
		group->grab_focus();
		break;
	
	case GDK_MOTION_NOTIFY:
		event_x = ev->motion.x;
		event_y = ev->motion.y;
		group->w2i(event_x, event_y);
				
		event_frame = trackview.editor.pixel_to_frame(event_x);
		trackview.editor.snap_to(event_frame);

		switch (_mouse_state) {
		case Pressed: // Drag start

			// Select drag start
			if (_pressed_button == 1 && trackview.editor.current_midi_edit_mode() == MidiEditSelect) {
				group->grab(GDK_POINTER_MOTION_MASK | GDK_BUTTON_RELEASE_MASK,
						Gdk::Cursor(Gdk::FLEUR), ev->motion.time);
				last_x = event_x;
				last_y = event_y;
				drag_start_x = event_x;
				drag_start_y = event_y;

				drag_rect = new ArdourCanvas::SimpleRect(*group);
				drag_rect->property_x1() = event_x;
				drag_rect->property_y1() = event_y;
				drag_rect->property_x2() = event_x;
				drag_rect->property_y2() = event_y;
				drag_rect->property_outline_what() = 0xFF;
				drag_rect->property_outline_color_rgba()
					= ARDOUR_UI::config()->canvasvar_MidiSelectRectOutline.get();
				drag_rect->property_fill_color_rgba()
					= ARDOUR_UI::config()->canvasvar_MidiSelectRectFill.get();

				_mouse_state = SelectRectDragging;
				return true;

			// Add note drag start
			} else if (trackview.editor.current_midi_edit_mode() == MidiEditPencil) {
				group->grab(GDK_POINTER_MOTION_MASK | GDK_BUTTON_RELEASE_MASK,
						Gdk::Cursor(Gdk::FLEUR), ev->motion.time);
				last_x = event_x;
				last_y = event_y;
				drag_start_x = event_x;
				drag_start_y = event_y;

				drag_rect = new ArdourCanvas::SimpleRect(*group);
				drag_rect->property_x1() = trackview.editor.frame_to_pixel(event_frame);
				
				drag_rect->property_y1() = midi_stream_view()->note_to_y(midi_stream_view()->y_to_note(event_y));
				drag_rect->property_x2() = event_x;
				drag_rect->property_y2() = drag_rect->property_y1() + floor(midi_stream_view()->note_height());
				drag_rect->property_outline_what() = 0xFF;
				drag_rect->property_outline_color_rgba() = 0xFFFFFF99;

				drag_rect->property_fill_color_rgba() = 0xFFFFFF66;

				_mouse_state = AddDragging;
				return true;
			}

			return false;

		case SelectRectDragging: // Select drag motion
		case AddDragging: // Add note drag motion
			if (ev->motion.is_hint) {
				int t_x;
				int t_y;
				GdkModifierType state;
				gdk_window_get_pointer(ev->motion.window, &t_x, &t_y, &state);
				event_x = t_x;
				event_y = t_y;
			}

			if (_mouse_state == AddDragging)
				event_x = trackview.editor.frame_to_pixel(event_frame);

			if (drag_rect)
				if (event_x > drag_start_x)
					drag_rect->property_x2() = event_x;
				else
					drag_rect->property_x1() = event_x;

			if (drag_rect && _mouse_state == SelectRectDragging) {
				if (event_y > drag_start_y)
					drag_rect->property_y2() = event_y;
				else
					drag_rect->property_y1() = event_y;
				
				update_drag_selection(drag_start_x, event_x, drag_start_y, event_y);
			}

			last_x = event_x;
			last_y = event_y;

		case EraseTouchDragging:
		case SelectTouchDragging:
			return false;

		default:
			break;
		}
		break;
	
	case GDK_BUTTON_RELEASE:
		event_x = ev->motion.x;
		event_y = ev->motion.y;
		group->w2i(event_x, event_y);
		group->ungrab(ev->button.time);
		event_frame = trackview.editor.pixel_to_frame(event_x);

		switch (_mouse_state) {
		case Pressed: // Clicked
			switch (trackview.editor.current_midi_edit_mode()) {
			case MidiEditSelect:
				clear_selection();
				break;
			case MidiEditPencil:
				trackview.editor.snap_to(event_frame, -1);
				event_x = trackview.editor.frame_to_pixel(event_frame);
				create_note_at(event_x, event_y, _default_note_length);
			default:
				break;
			}
			_mouse_state = None;
			return true;
		case SelectRectDragging: // Select drag done
			_mouse_state = None;
			delete drag_rect;
			drag_rect = NULL;
			return true;
		case AddDragging: // Add drag done
			_mouse_state = None;
			if (drag_rect->property_x2() > drag_rect->property_x1() + 2) {
				create_note_at(drag_rect->property_x1(), drag_rect->property_y1(),
						trackview.editor.pixel_to_frame(
						drag_rect->property_x2() - drag_rect->property_x1()));
			}

			delete drag_rect;
			drag_rect = NULL;
			return true;
		default:
			break;
		}
	
	default:
		break;
	}

	return false;
}


/** Add a note to the model, and the view, at a canvas (click) coordinate */
void
MidiRegionView::create_note_at(double x, double y, double dur)
{
	MidiTimeAxisView* const mtv = dynamic_cast<MidiTimeAxisView*>(&trackview);
	MidiStreamView* const view = mtv->midi_view();

	double note = midi_stream_view()->y_to_note(y);

	assert(note >= 0.0);
	assert(note <= 127.0);

	const nframes_t stamp = trackview.editor.pixel_to_frame (x);
	assert(stamp >= 0);
	//assert(stamp <= _region->length());

	//const Meter& m = trackview.session().tempo_map().meter_at(stamp);
	//const Tempo& t = trackview.session().tempo_map().tempo_at(stamp);
	//double dur = m.frames_per_bar(t, trackview.session().frame_rate()) / m.beats_per_bar();

	// Add a 1 beat long note (for now)
	const boost::shared_ptr<Note> new_note(new Note(stamp, dur, (uint8_t)note, 0x40));
	
	view->update_bounds(new_note->note());

	MidiModel::DeltaCommand* cmd = _model->new_delta_command("add note");
	cmd->add(new_note);
	_model->apply_command(cmd);
	
	//add_note(new_note);
}


void
MidiRegionView::clear_events()
{
	for (std::vector<CanvasMidiEvent*>::iterator i = _events.begin(); i != _events.end(); ++i)
		delete *i;
	
	_events.clear();
}


void
MidiRegionView::display_model(boost::shared_ptr<MidiModel> model)
{
	_model = model;

	if (_enable_display)
		redisplay_model();
}


void
MidiRegionView::redisplay_model()
{
	// Don't redisplay the model if we're currently recording and displaying that
	if (_active_notes)
		return;
	
	if (_model) {

		clear_events();
		begin_write();
		
		_model->read_lock();

		for (size_t i=0; i < _model->n_notes(); ++i)
			add_note(_model->note_at(i));

		end_write();

		/*for (Automatable::Controls::const_iterator i = _model->controls().begin();
				i != _model->controls().end(); ++i) {

			assert(i->second);

			boost::shared_ptr<AutomationTimeAxisView> at
				= midi_view()->automation_child(i->second->parameter());
			if (!at)
				continue;

			Gdk::Color col = midi_stream_view()->get_region_color();
				
			boost::shared_ptr<AutomationRegionView> arv;

			{
				Glib::Mutex::Lock list_lock (i->second->list()->lock());

				arv = boost::shared_ptr<AutomationRegionView>(
						new AutomationRegionView(at->canvas_display,
							*at.get(), _region, i->second->list(),
							midi_stream_view()->get_samples_per_unit(), col));
			}

			arv->set_duration(_region->length(), this);
			arv->init(col, true);

			_automation_children.insert(std::make_pair(i->second->parameter(), arv));
		}*/
		
		_model->read_unlock();

	} else {
		cerr << "MidiRegionView::redisplay_model called without a model" << endmsg;
	}
}


MidiRegionView::~MidiRegionView ()
{
	in_destructor = true;
	if (_active_notes)
		end_write();

	clear_events();

	RegionViewGoingAway (this); /* EMIT_SIGNAL */
}


void
MidiRegionView::region_resized (Change what_changed)
{
	RegionView::region_resized(what_changed);

	if (what_changed & ARDOUR::PositionChanged) {
	
		if (_enable_display)
			redisplay_model();
	
	} else if (what_changed & Change (StartChanged)) {

		//cerr << "MIDI RV START CHANGED" << endl;

	} else if (what_changed & Change (LengthChanged)) {
		
		//cerr << "MIDI RV LENGTH CHANGED" << endl;
	
	}
}

void
MidiRegionView::reset_width_dependent_items (double pixel_width)
{
	RegionView::reset_width_dependent_items(pixel_width);
	assert(_pixel_width == pixel_width);
		
	if (_enable_display)
		redisplay_model();
}

void
MidiRegionView::set_y_position_and_height (double y, double h)
{
	RegionView::set_y_position_and_height(y, h - 1);

	if (_enable_display) {
		
		_model->read_lock();

		for (std::vector<CanvasMidiEvent*>::const_iterator i = _events.begin(); i != _events.end(); ++i) {
			CanvasNote* note = dynamic_cast<CanvasNote*>(*i);
			if (note && note->note()) {
				const double y1 = midi_stream_view()->note_to_y(note->note()->note());
				const double y2 = y1 + floor(midi_stream_view()->note_height());

				note->property_y1() = y1;
				note->property_y2() = y2;
			}
		}
		
		_model->read_unlock();
	}

	if (name_text) {
		name_text->raise_to_top();
	}
}

GhostRegion*
MidiRegionView::add_ghost (AutomationTimeAxisView& atv)
{
	RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(&trackview);
	assert(rtv);

	double unit_position = _region->position () / samples_per_unit;
	GhostRegion* ghost = new GhostRegion (atv, unit_position);

	ghost->set_height ();
	ghost->set_duration (_region->length() / samples_per_unit);
	ghosts.push_back (ghost);

	ghost->GoingAway.connect (mem_fun(*this, &MidiRegionView::remove_ghost));

	return ghost;
}


/** Begin tracking note state for successive calls to add_event
 */
void
MidiRegionView::begin_write()
{
	assert(!_active_notes);
	_active_notes = new CanvasNote*[128];
	for (unsigned i=0; i < 128; ++i)
		_active_notes[i] = NULL;
}


/** Destroy note state for add_event
 */
void
MidiRegionView::end_write()
{
	delete[] _active_notes;
	_active_notes = NULL;
}


/** Resolve an active MIDI note (while recording).
 */
void
MidiRegionView::resolve_note(uint8_t note, double end_time)
{
	if (midi_view()->note_mode() != Sustained)
		return;

	if (_active_notes && _active_notes[note]) {
		_active_notes[note]->property_x2() = trackview.editor.frame_to_pixel((nframes_t)end_time);
		_active_notes[note]->property_outline_what() = (guint32) 0xF; // all edges
		_active_notes[note] = NULL;
	}
}


/** Extend active notes to rightmost edge of region (if length is changed)
 */
void
MidiRegionView::extend_active_notes()
{
	if (!_active_notes)
		return;

	for (unsigned i=0; i < 128; ++i)
		if (_active_notes[i])
			_active_notes[i]->property_x2() = trackview.editor.frame_to_pixel(_region->length());
}


/** Add a MIDI note to the view (with duration).
 *
 * If in sustained mode, notes with duration 0 will be considered active
 * notes, and resolve_note should be called when the corresponding note off
 * event arrives, to properly display the note.
 */
void
MidiRegionView::add_note(const boost::shared_ptr<Note> note)
{
	assert(note->time() >= 0);
	//assert(note->time() < _region->length());

	ArdourCanvas::Group* const group = (ArdourCanvas::Group*)get_canvas_group();
	
	if (midi_view()->note_mode() == Sustained) {
	
		//cerr << "MRV::add_note sustained " << note->note() << " @ " << note->time()
		//	<< " .. " << note->end_time() << endl;

		const double y1 = midi_stream_view()->note_to_y(note->note());

		CanvasNote* ev_rect = new CanvasNote(*this, *group, note);
		ev_rect->property_x1() = trackview.editor.frame_to_pixel((nframes_t)note->time());
		ev_rect->property_y1() = y1;
		if (note->duration() > 0)
			ev_rect->property_x2() = trackview.editor.frame_to_pixel((nframes_t)(note->end_time()));
		else
			ev_rect->property_x2() = trackview.editor.frame_to_pixel(_region->length());
		ev_rect->property_y2() = y1 + floor(midi_stream_view()->note_height());

		ev_rect->property_fill_color_rgba() = note_fill_color(note->velocity());
		ev_rect->property_outline_color_rgba() = note_outline_color(note->velocity());

		if (note->duration() == 0) {
			_active_notes[note->note()] = ev_rect;
			/* outline all but right edge */
			ev_rect->property_outline_what() = (guint32) (0x1 & 0x4 & 0x8);
		} else {
			/* outline all edges */
			ev_rect->property_outline_what() = (guint32) 0xF;
		}
		
		ev_rect->show();
		_events.push_back(ev_rect);

	} else if (midi_view()->note_mode() == Percussive) {
		
		//cerr << "MRV::add_note percussive " << note->note() << " @ " << note->time() << endl;
		
		const double diamond_size = midi_stream_view()->note_height() / 2.0;
		const double x = trackview.editor.frame_to_pixel((nframes_t)note->time());
		const double y = midi_stream_view()->note_to_y(note->note()) + ((diamond_size-2) / 4.0);

		CanvasHit* ev_diamond = new CanvasHit(*this, *group, diamond_size);
		ev_diamond->move(x, y);
		ev_diamond->show();
		ev_diamond->property_fill_color_rgba() = note_fill_color(note->velocity());
		ev_diamond->property_outline_color_rgba() = note_outline_color(note->velocity());
		_events.push_back(ev_diamond);
	}
}

void
MidiRegionView::delete_selection()
{
	assert(_delta_command);

	for (Selection::iterator i = _selection.begin(); i != _selection.end(); ++i)
		if ((*i)->selected())
			_delta_command->remove((*i)->note());

	_selection.clear();
}

void
MidiRegionView::clear_selection_except(ArdourCanvas::CanvasMidiEvent* ev)
{
	for (Selection::iterator i = _selection.begin(); i != _selection.end(); ++i)
		if ((*i)->selected() && (*i) != ev)
			(*i)->selected(false);

	_selection.clear();
}

void
MidiRegionView::unique_select(ArdourCanvas::CanvasMidiEvent* ev)
{
	for (Selection::iterator i = _selection.begin(); i != _selection.end(); ++i)
		if ((*i) != ev)
			(*i)->selected(false);

	_selection.clear();
	_selection.insert(ev);
	
	if ( ! ev->selected())
		ev->selected(true);
}
	
void
MidiRegionView::note_selected(ArdourCanvas::CanvasMidiEvent* ev, bool add)
{
	if ( ! add)
		clear_selection_except(ev);
	
	_selection.insert(ev);
	
	if ( ! ev->selected())
		ev->selected(true);
}


void
MidiRegionView::note_deselected(ArdourCanvas::CanvasMidiEvent* ev, bool add)
{
	if ( ! add)
		clear_selection_except(ev);
	
	_selection.erase(ev);
	
	if (ev->selected())
		ev->selected(false);
}


void
MidiRegionView::update_drag_selection(double x1, double x2, double y1, double y2)
{
	const double last_y = std::min(y1, y2);
	const double y      = std::max(y1, y2);
	
	// FIXME: so, so, so much slower than this should be

	if (x1 < x2) {
		for (std::vector<CanvasMidiEvent*>::iterator i = _events.begin(); i != _events.end(); ++i) {
			if ((*i)->x1() >= x1 && (*i)->x1() <= x2 && (*i)->y1() >= last_y && (*i)->y1() <= y) {
				(*i)->selected(true);
				_selection.insert(*i);
			} else {
				(*i)->selected(false);
				_selection.erase(*i);
			}
		}
	} else {
		for (std::vector<CanvasMidiEvent*>::iterator i = _events.begin(); i != _events.end(); ++i) {
			if ((*i)->x2() <= x1 && (*i)->x2() >= x2 && (*i)->y1() >= last_y && (*i)->y1() <= y) {
				(*i)->selected(true);
				_selection.insert(*i);
			} else {
				(*i)->selected(false);
				_selection.erase(*i);
			}
		}
	}
}

	
void
MidiRegionView::move_selection(double dx, double dy)
{
	for (Selection::iterator i = _selection.begin(); i != _selection.end(); ++i)
		(*i)->item()->move(dx, dy);
}


void
MidiRegionView::note_dropped(CanvasMidiEvent* ev, double dt, uint8_t dnote)
{
	// TODO: This would be faster/nicer with a MoveCommand that doesn't need to copy...
	if (_selection.find(ev) != _selection.end()) {
		start_delta_command();

		for (Selection::iterator i = _selection.begin(); i != _selection.end(); ++i) {
			command_remove_note(*i);
			const boost::shared_ptr<Note> copy(new Note(*(*i)->note().get())); 

			copy->set_time((*i)->note()->time() + dt);
			copy->set_note((*i)->note()->note() + dnote);

			command_add_note(copy);
		}
		apply_command();
	}
}
	

void
MidiRegionView::note_entered(ArdourCanvas::CanvasMidiEvent* ev)
{
	if (ev->note() && _mouse_state == EraseTouchDragging) {
		start_delta_command();
		ev->selected(true);
		_delta_command->remove(ev->note());
	} else if (_mouse_state == SelectTouchDragging) {
		note_selected(ev, true);
	}
}
	

void
MidiRegionView::switch_source(boost::shared_ptr<Source> src)
{
	boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
	if (msrc)
		display_model(msrc->model());
}