Grey-out patch changes on inactive channels rather than not
[ardour.git] / gtk2_ardour / midi_region_view.h
index 9a9ea3c265d214d64020fcd003d678cffbad8028..f47c94a1a96fbbbdd0bc6f710362cf345744e956 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2001-2007 Paul Davis
+    Copyright (C) 2001-2011 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
@@ -28,7 +28,6 @@
 #include "pbd/signals.h"
 
 #include "ardour/midi_track.h"
-#include "ardour/midi_region.h"
 #include "ardour/midi_model.h"
 #include "ardour/diskstream.h"
 #include "ardour/types.h"
@@ -43,7 +42,7 @@
 #include "canvas-hit.h"
 #include "canvas-note.h"
 #include "canvas-note-event.h"
-#include "canvas-program-change.h"
+#include "canvas_patch_change.h"
 #include "canvas-sysex.h"
 
 namespace ARDOUR {
@@ -64,10 +63,11 @@ class AutomationTimeAxisView;
 class AutomationRegionView;
 class MidiCutBuffer;
 class MidiListEditor;
+class EditNoteDialog;
 
 class MidiRegionView : public RegionView
 {
-  public:
+public:
        typedef Evoral::Note<Evoral::MusicalTime> NoteType;
        typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
 
@@ -84,24 +84,29 @@ class MidiRegionView : public RegionView
 
        virtual void init (Gdk::Color const & basic_color, bool wfd);
 
-       inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
-               { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
+       const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
 
        inline MidiTimeAxisView* midi_view() const
-               { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
+       { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
 
        inline MidiStreamView* midi_stream_view() const
-               { return midi_view()->midi_view(); }
-
-       void add_note (uint8_t channel, uint8_t number, uint8_t velocity,
-                      Evoral::MusicalTime pos, Evoral::MusicalTime len);
+       { return midi_view()->midi_view(); }
 
+       void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
+                           Evoral::MusicalTime pos, Evoral::MusicalTime len);
+       void step_sustain (Evoral::MusicalTime beats);
        void set_height (double);
        void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 
        inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
 
        void set_frame_color();
+       void color_handler ();
+
+       void show_step_edit_cursor (Evoral::MusicalTime pos);
+       void move_step_edit_cursor (Evoral::MusicalTime pos);
+       void hide_step_edit_cursor ();
+       void set_step_edit_cursor_width (Evoral::MusicalTime beats);
 
        void redisplay_model();
 
@@ -111,55 +116,44 @@ class MidiRegionView : public RegionView
        void resolve_note(uint8_t note_num, double end_time);
 
        void cut_copy_clear (Editing::CutCopyOp);
-       void paste (nframes64_t pos, float times, const MidiCutBuffer&);
-
-       struct PCEvent {
-               PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
-                       : time(a_time), value(a_value), channel(a_channel) {}
+       void paste (framepos_t pos, float times, const MidiCutBuffer&);
 
-               double  time;
-               uint8_t value;
-               uint8_t channel;
-       };
-
-       /** Add a new program change flag to the canvas.
-        * @param program the MidiRegionView::PCEvent to add
-        * @param the text to display in the flag
-        */
-       void add_pgm_change(PCEvent& program, const std::string& displaytext);
+       void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
 
        /** Look up the given time and channel in the 'automation' and set keys accordingly.
-        * @param time the time of the program change event
+        * @param time the time of the patch change event
         * @param channel the MIDI channel of the event
         * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
         *        will be set according to the result of the lookup
         */
        void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
 
-       /** Change the 'automation' data of old_program to new values which correspond to new_patch.
-        * @param old_program the program change event which is to be altered
-        * @param new_patch the new lsb, msb and program number which are to be set
+       /** Change old_patch to new_patch.
+        * @param old_patch the canvas patch change which is to be altered
+        * @param new_patch new patch
         */
-       void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
+       void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
+       void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
 
-       /** Alter a given program to the new given one.
-        * (Called on context menu select on CanvasProgramChange)
-        */
-       void program_selected(
-               ArdourCanvas::CanvasProgramChange& program,
-               const MIDI::Name::PatchPrimaryKey& new_patch);
+       void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
+       void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
+       void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
+       void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
 
-       /** Alter a given program to be its predecessor in the MIDNAM file.
+       /** Alter a given patch to be its predecessor in the MIDNAM file.
         */
-       void previous_program(ArdourCanvas::CanvasProgramChange& program);
+       void previous_patch (ArdourCanvas::CanvasPatchChange &);
 
-       /** Alters a given program to be its successor in the MIDNAM file.
+       /** Alters a given patch to be its successor in the MIDNAM file.
         */
-       void next_program(ArdourCanvas::CanvasProgramChange& program);
+       void next_patch (ArdourCanvas::CanvasPatchChange &);
+
+       void previous_bank (ArdourCanvas::CanvasPatchChange &);
+       void next_bank (ArdourCanvas::CanvasPatchChange &);
 
-       /** Displays all program change events in the region as flags on the canvas.
+       /** Displays all patch change events in the region as flags on the canvas.
         */
-       void display_program_changes();
+       void display_patch_changes();
 
        /** Displays all system exclusive events in the region as flags on the canvas.
         */
@@ -169,34 +163,37 @@ class MidiRegionView : public RegionView
        void end_write();
        void extend_active_notes();
 
-       void create_note_at(double x, double y, double length);
-
        void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 
-       void start_delta_command(std::string name = "midi edit");
-       void delta_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
-       void delta_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
+       void start_note_diff_command (std::string name = "midi edit");
+       void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
+       void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
+       void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
+       void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
 
-       void start_diff_command(std::string name = "midi edit");
-       void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, uint8_t val);
-       void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, Evoral::MusicalTime val);
-
-       void apply_delta();
-       void apply_diff();
-       void apply_delta_as_subcommand();
-       void apply_diff_as_subcommand();
+       void apply_diff (bool as_subcommand = false);
        void abort_command();
 
        void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
        void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
+       void   patch_entered (ArdourCanvas::CanvasPatchChange *);
+       void   patch_left (ArdourCanvas::CanvasPatchChange *);
+       void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
        void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
        void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
        void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
        void   delete_selection();
+       void   delete_note (boost::shared_ptr<NoteType>);
        size_t selection_size() { return _selection.size(); }
+       void   select_all_notes ();
+       void   select_range(framepos_t start, framepos_t end);
+       void   invert_selection ();
+
+       void move_selection(double dx, double dy, double cumulative_dy);
+       void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
 
-       void move_selection(double dx, double dy);
-       void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, int8_t d_note);
+       void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
+       void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 
        /** Return true iff the note is within the extent of the region.
         * @param visible will be set to true if the note is within the visible note range, false otherwise.
@@ -215,26 +212,9 @@ class MidiRegionView : public RegionView
         */
        void begin_resizing(bool at_front);
 
-       /** Update resizing notes while user drags.
-        * @param at_front which end of the note (true == note on, false == 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(bool at_front, double x, bool relative);
-
-       /** Finish resizing notes when the user releases the mouse button.
-        * @param at_front which end of the note (true == note on, false == 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(bool at_front, double event_x, bool relative);
-
-       /** Adjust the velocity on a note, and the selection if applicable.
-        * @param velocity the relative or absolute velocity
-        * @param relative whether velocity is relative or absolute
-        */
-       void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
+       void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
+       void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
+       void abort_resizing ();
 
        /** Change the channel of the selection.
         * @param channel - the channel number of the new channel, zero-based
@@ -246,6 +226,7 @@ class MidiRegionView : public RegionView
                Pressed,
                SelectTouchDragging,
                SelectRectDragging,
+               SelectVerticalDragging,
                AddDragging
        };
 
@@ -264,34 +245,62 @@ class MidiRegionView : public RegionView
 
        /** Snap a region relative pixel coordinate to frame units.
         * @param x a pixel coordinate relative to region start
-        * @return the snapped nframes64_t coordinate relative to region start
+        * @return the snapped framepos_t coordinate relative to region start
         */
-       nframes64_t snap_pixel_to_frame(double x);
+       framepos_t snap_pixel_to_frame(double x);
+
+       /** Convert a timestamp in beats into frames (both relative to region position) */
+       framepos_t region_beats_to_region_frames(double beats) const;
+       /** Convert a timestamp in beats into absolute frames */
+       framepos_t region_beats_to_absolute_frames(double beats) const {
+               return _region->position() + region_beats_to_region_frames (beats);
+       }
+       /** Convert a timestamp in frames to beats (both relative to region position) */
+       double region_frames_to_region_beats(framepos_t) const;
+
+       /** Convert a timestamp in beats measured from source start into absolute frames */
+       framepos_t source_beats_to_absolute_frames(double beats) const;
+       /** Convert a timestamp in beats measured from source start into region-relative frames */
+       framepos_t source_beats_to_region_frames(double beats) const {
+               return source_beats_to_absolute_frames (beats) - _region->position();
+       }
+       /** Convert a timestamp in absolute frames to beats measured from source start*/
+       double absolute_frames_to_source_beats(framepos_t) const;
+
+       void goto_previous_note (bool add_to_selection);
+       void goto_next_note (bool add_to_selection);
+       void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
+        void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
+       void transpose (bool up, bool fine, bool allow_smush);
+       void nudge_notes (bool forward);
+       void channel_edit ();
+       void velocity_edit ();
 
-       /** Snap a region relative frame coordinate to frame units.
-        * @param x a pixel coordinate relative to region start
-        * @return the snapped nframes64_t coordinate relative to region start
-        */
-       nframes64_t snap_frame_to_frame(nframes64_t x);
+       void show_list_editor ();
 
-       /** Convert a timestamp in beats to frames (both relative to region start) */
-       nframes64_t beats_to_frames(double beats) const;
+       void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 
-       /** Convert a timestamp in frames to beats (both relative to region start) */
-       double frames_to_beats(nframes64_t beats) const;
+       void enable_display (bool);
 
-       void goto_previous_note ();
-       void goto_next_note ();
-       void change_note_lengths (bool, bool, bool start, bool end);
-       void change_velocities (bool up, bool fine, bool allow_smush);
-       void transpose (bool up, bool fine, bool allow_smush);
-       void nudge_notes (bool forward);
+       void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
+       ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 
-       void show_list_editor ();
+       void trim_front_starting ();
+       void trim_front_ending ();
 
-       void selection_as_notelist (Notes& selected);
+       void create_note_at (framepos_t, double, double, bool);
 
-  protected:
+       void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
+
+       std::string model_name () const {
+               return _model_name;
+       }
+
+       std::string custom_device_mode () const {
+               return _custom_device_mode;
+       }
+       
+protected:
        /** Allows derived types to specify their visibility requirements
         * to the TimeAxisViewItem parent class.
         */
@@ -302,18 +311,35 @@ class MidiRegionView : public RegionView
                        Gdk::Color& basic_color,
                        TimeAxisViewItem::Visibility);
 
-       void region_resized (ARDOUR::Change);
+       void region_resized (const PBD::PropertyChange&);
 
        void set_flags (XMLNode *);
        void store_flags ();
 
        void reset_width_dependent_items (double pixel_width);
 
-  private:
+       void parameter_changed (std::string const & p);
+
+private:
+
+       friend class MidiRubberbandSelectDrag;
+       friend class MidiVerticalSelectDrag;
+
+       /** Emitted when the selection has been cleared in one MidiRegionView,
+        *  with the expectation that others will clear their selections in
+        *  sympathy.
+        */
+       static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
+       PBD::ScopedConnection _selection_cleared_connection;
+       void selection_cleared (MidiRegionView *);
+
+       friend class EditNoteDialog;
+
        /** Play the NoteOn event of the given note immediately
         * and schedule the playback of the corresponding NoteOff event.
         */
        void play_midi_note(boost::shared_ptr<NoteType> note);
+       void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 
        /** Play the NoteOff-Event of the given note immediately
         * (scheduled by @ref play_midi_note()).
@@ -321,7 +347,6 @@ class MidiRegionView : public RegionView
        bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 
        void clear_events();
-       void switch_source(boost::shared_ptr<ARDOUR::Source> src);
 
        bool canvas_event(GdkEvent* ev);
        bool note_canvas_event(GdkEvent* ev);
@@ -329,22 +354,25 @@ class MidiRegionView : public RegionView
        void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
        void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
 
+       void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
        void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
        void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
        void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
+       void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
        void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
-                      ARDOUR::MidiModel::TimeType end_delta);
+                      ARDOUR::MidiModel::TimeType end_delta);
 
-       void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
-       void clear_selection() { clear_selection_except(NULL); }
-       void update_drag_selection(double last_x, double x, double last_y, double y);
+       void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
+       void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
+       void update_vertical_drag_selection (double last_y, double y, bool extend);
 
        void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
        void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 
-       int8_t   _force_channel;
+       void show_verbose_cursor (std::string const &, double, double) const;
+       void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
+
        uint16_t _last_channel_selection;
-       double   _default_note_length;
        uint8_t  _current_range_min;
        uint8_t  _current_range_max;
 
@@ -355,17 +383,29 @@ class MidiRegionView : public RegionView
        std::string _custom_device_mode;
 
        typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
-       typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
+       typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
        typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 
        boost::shared_ptr<ARDOUR::MidiModel> _model;
        Events                               _events;
-       PgmChanges                           _pgm_changes;
+       PatchChanges                         _patch_changes;
        SysExes                              _sys_exes;
        ArdourCanvas::CanvasNote**           _active_notes;
        ArdourCanvas::Group*                 _note_group;
-       ARDOUR::MidiModel::DeltaCommand*     _delta_command;
-       ARDOUR::MidiModel::DiffCommand*      _diff_command;
+       ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
+       ArdourCanvas::CanvasNote*            _ghost_note;
+       double                               _last_ghost_x;
+       double                               _last_ghost_y;
+       ArdourCanvas::SimpleRect*            _step_edit_cursor;
+       Evoral::MusicalTime                  _step_edit_cursor_width;
+       Evoral::MusicalTime                  _step_edit_cursor_position;
+       ArdourCanvas::CanvasNoteEvent*       _channel_selection_scoped_note;
+
+
+       /** A group used to temporarily reparent _note_group to during start trims, so
+        *  that the notes don't move with the parent region view.
+        */
+       ArdourCanvas::Group*                 _temporary_note_group;
 
        MouseState _mouse_state;
        int _pressed_button;
@@ -389,16 +429,55 @@ class MidiRegionView : public RegionView
 
        std::vector<NoteResizeData *> _resize_data;
 
-       /* connection used to connect to model's ContentChanged signal */
+       /** connection used to connect to model's ContentChanged signal */
        PBD::ScopedConnection content_connection;
 
        ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
        Events::iterator _optimization_iterator;
 
-       void update_note (ArdourCanvas::CanvasNote*);
-       void update_hit (ArdourCanvas::CanvasHit*);
+       void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
+       double update_hit (ArdourCanvas::CanvasHit *);
+       void create_ghost_note (double, double);
+       void update_ghost_note (double, double);
 
        MidiListEditor* _list_editor;
+       bool _no_sound_notes;
+
+       PBD::ScopedConnection note_delete_connection;
+       void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
+
+       void snap_changed ();
+       PBD::ScopedConnection snap_changed_connection;
+
+       bool motion (GdkEventMotion*);
+       bool scroll (GdkEventScroll*);
+       bool key_press (GdkEventKey*);
+       bool key_release (GdkEventKey*);
+       bool button_press (GdkEventButton*);
+       bool button_release (GdkEventButton*);
+       bool enter_notify (GdkEventCrossing*);
+       bool leave_notify (GdkEventCrossing*);
+
+       void drop_down_keys ();
+       void maybe_select_by_position (GdkEventButton* ev, double x, double y);
+       void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
+
+       void display_patch_changes_on_channel (uint8_t, bool);
+
+       void connect_to_diskstream ();
+       void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
+
+       void remove_ghost_note ();
+       void mouse_mode_changed ();
+       double _last_event_x;
+       double _last_event_y;
+
+       framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
+       
+       PBD::ScopedConnection _mouse_mode_connection;
+
+       Gdk::Cursor* pre_enter_cursor;
+       Gdk::Cursor* pre_press_cursor;
 };