ardour/gtk2_ardour/midi_region_view.h

/*
    Copyright (C) 2001-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.
*/

#ifndef __gtk_ardour_midi_region_view_h__
#define __gtk_ardour_midi_region_view_h__

#include <vector>

#include <libgnomecanvasmm.h>
#include <libgnomecanvasmm/polygon.h>
#include <ardour/midi_track.h>
#include <ardour/midi_region.h>
#include <ardour/midi_model.h>
#include <ardour/diskstream.h>
#include <ardour/types.h>

#include "region_view.h"
#include "midi_time_axis.h"
#include "time_axis_view_item.h"
#include "automation_line.h"
#include "enums.h"
#include "canvas.h"
#include "canvas-note.h"
#include "canvas-midi-event.h"

namespace ARDOUR {
	class MidiRegion;
	class MidiModel;
};

class MidiTimeAxisView;
class GhostRegion;
class AutomationTimeAxisView;
class AutomationRegionView;

class MidiRegionView : public RegionView
{
  public:
	MidiRegionView (ArdourCanvas::Group *,
	                RouteTimeAxisView&,
	                boost::shared_ptr<ARDOUR::MidiRegion>,
	                double initial_samples_per_unit,
	                Gdk::Color& basic_color);

	~MidiRegionView ();

	virtual void init (Gdk::Color& basic_color, bool wfd);

	inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
		{ return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }

	inline MidiTimeAxisView* midi_view() const
		{ return dynamic_cast<MidiTimeAxisView*>(&trackview); }

	inline MidiStreamView* midi_stream_view() const
		{ return midi_view()->midi_view(); }

	void set_y_position_and_height (double, double);

	void set_frame_color();

	void redisplay_model();

	GhostRegion* add_ghost (TimeAxisView&);

	void add_note(const boost::shared_ptr<ARDOUR::Note> note);
	void resolve_note(uint8_t note_num, double end_time);

	void begin_write();
	void end_write();
	void extend_active_notes();

	void create_note_at(double x, double y, double duration);

	void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);

	/* This stuff is a bit boilerplatey ATM.  Work in progress. */

	inline void start_delta_command(string name = "midi edit") {
		if (!_delta_command)
			_delta_command = _model->new_delta_command(name);
	}

	void command_add_note(const boost::shared_ptr<ARDOUR::Note> note) {
		if (_delta_command)
			_delta_command->add(note);
	}

	void command_remove_note(ArdourCanvas::CanvasMidiEvent* ev) {
		if (_delta_command && ev->note()) {
			_selection.erase(ev);
			_delta_command->remove(ev->note());
			ev->selected(true);
		}
	}

	void abort_command() {
		delete _delta_command;
		_delta_command = NULL;
		clear_selection();
	}

	void apply_command() {
		if (_delta_command) {
			_model->apply_command(_delta_command);
			_delta_command = NULL;
		}
		midi_view()->midi_track()->diskstream()->playlist_modified();
	}

	void   note_entered(ArdourCanvas::CanvasMidiEvent* ev);
	void   unique_select(ArdourCanvas::CanvasMidiEvent* ev);
	void   note_selected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
	void   note_deselected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
	void   delete_selection();
	size_t selection_size() { return _selection.size(); }

	void move_selection(double dx, double dy);
	void note_dropped(ArdourCanvas::CanvasMidiEvent* ev, double dt, uint8_t dnote);

	/**
	 * This function is needed to subtract the region start in pixels
	 * from world coordinates submitted by the mouse
	 */
	double get_position_pixels(void);

	/**
	 * This function is called by CanvasMidiNote when resizing starts,
	 * i.e. when the user presses mouse-2 on the note
	 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
	 */
	void  begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);

	/**
	 * This function is called while the user moves the mouse when resizing notes
	 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
	 * @param x the difference in mouse motion, ie the motion difference if relative=true
	 *           or the absolute mouse position (track-relative) if relative is false
	 * @param relative true if relative resizing is taking place, false if absolute resizing
	 */
	void update_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double x, bool relative);

	/**
	 * This function is called while the user releases the mouse button when resizing notes
	 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
	 * @param event_x the absolute mouse position (track-relative)
	 * @param relative true if relative resizing is taking place, false if absolute resizing
	 */
	void commit_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double event_x, bool relative);

	/**
	 * This function is called while the user adjusts the velocity on a selection of notes
	 * @param velocity the relative or absolute velocity, depending on the value of relative
	 * @param relative true if the given velocity represents a delta to be applied to all notes, false
	 *        if the absolute value of the note shoud be set
	 */
	void change_velocity(uint8_t velocity, bool relative=false);
	
	/**
	 * This function is called when the user adjusts the midi channel of a selection of notes
	 * @param channel - the channel number of the new channel, zero-based
	 */
	void change_channel(uint8_t channel);

	enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
	MouseState mouse_state() const { return _mouse_state; }

	struct NoteResizeData {
		ArdourCanvas::CanvasNote  *canvas_note;
		ArdourCanvas::SimpleRect  *resize_rect;
		double                     current_x;
	};
	
	/**
	 * This function provides the snap function for region position relative coordinates
	 * for pixel units (double) instead of nframes_t
	 * @param x a pixel coordinate relative to region start
	 * @return the snapped pixel coordinate relative to region start
	 */
	double snap_to_pixel(double x);

	/**
	 * This function provides the snap function for region position relative coordinates
	 * for pixel units (double) instead of nframes_t
	 * @param x a pixel coordinate relative to region start
	 * @return the snapped nframes_t coordinate relative to region start
	 */
	nframes_t snap_to_frame(double x);

	/**
	 * This function provides the snap function for region position relative coordinates
	 * @param x a pixel coordinate relative to region start
	 * @return the snapped nframes_t coordinate relative to region start
	 */
	nframes_t snap_to_frame(nframes_t x);
	
  protected:

    /**
     * this constructor allows derived types
     * to specify their visibility requirements
     * to the TimeAxisViewItem parent class
    */
    MidiRegionView (ArdourCanvas::Group *,
	                RouteTimeAxisView&,
	                boost::shared_ptr<ARDOUR::MidiRegion>,
	                double samples_per_unit,
	                Gdk::Color& basic_color,
	                TimeAxisViewItem::Visibility);

    void region_resized (ARDOUR::Change);

    void set_flags (XMLNode *);
    void store_flags ();

	void reset_width_dependent_items (double pixel_width);

  private:

	void clear_events();
	void switch_source(boost::shared_ptr<ARDOUR::Source> src);

	bool canvas_event(GdkEvent* ev);
	bool note_canvas_event(GdkEvent* ev);
	
	uint16_t last_channel_selection;
	void midi_channel_selection_changed(uint16_t selection);

	void clear_selection_except(ArdourCanvas::CanvasMidiEvent* ev);
	void clear_selection() { clear_selection_except(NULL); }
	void update_drag_selection(double last_x, double x, double last_y, double y);

	double _default_note_length;

	boost::shared_ptr<ARDOUR::MidiModel>        _model;
	std::vector<ArdourCanvas::CanvasMidiEvent*> _events;
	ArdourCanvas::CanvasNote**                  _active_notes;
	ArdourCanvas::Group*                        _note_group;
	ARDOUR::MidiModel::DeltaCommand*            _delta_command;

	MouseState _mouse_state;
	int _pressed_button;

	/// currently selected CanvasMidiEvents
	typedef std::set<ArdourCanvas::CanvasMidiEvent*> Selection;
	Selection _selection;

	/**
	 * this enables vanilla notes to be marked for selection
	 * they are added to _selection when redisplay_model is called
	 * this is necessary for selecting notes during/after model manipulations 
	 */
	std::set< boost::shared_ptr<ARDOUR::Note> > _marked_for_selection;

	std::vector<NoteResizeData *> _resize_data;
};

#endif /* __gtk_ardour_midi_region_view_h__ */