Add some comments to the RegionSelection class.
[ardour.git] / gtk2_ardour / midi_region_view.h
1 /*
2     Copyright (C) 2001-2007 Paul Davis 
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
19 #ifndef __gtk_ardour_midi_region_view_h__
20 #define __gtk_ardour_midi_region_view_h__
21
22 #include <vector>
23
24 #include <libgnomecanvasmm.h>
25 #include <libgnomecanvasmm/polygon.h>
26 #include <ardour/midi_track.h>
27 #include <ardour/midi_region.h>
28 #include <ardour/midi_model.h>
29 #include <ardour/diskstream.h>
30 #include <ardour/types.h>
31
32 #include "region_view.h"
33 #include "midi_time_axis.h"
34 #include "time_axis_view_item.h"
35 #include "automation_line.h"
36 #include "enums.h"
37 #include "canvas.h"
38 #include "canvas-note.h"
39 #include "canvas-midi-event.h"
40
41 namespace ARDOUR {
42         class MidiRegion;
43         class MidiModel;
44 };
45
46 class MidiTimeAxisView;
47 class GhostRegion;
48 class AutomationTimeAxisView;
49 class AutomationRegionView;
50
51 class MidiRegionView : public RegionView
52 {
53   public:
54         MidiRegionView (ArdourCanvas::Group *, 
55                         RouteTimeAxisView&,
56                         boost::shared_ptr<ARDOUR::MidiRegion>,
57                         double initial_samples_per_unit,
58                         Gdk::Color& basic_color);
59
60         ~MidiRegionView ();
61         
62         virtual void init (Gdk::Color& basic_color, bool wfd);
63         
64         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
65                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
66
67         inline MidiTimeAxisView* midi_view() const
68                 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
69
70         inline MidiStreamView* midi_stream_view() const
71                 { return midi_view()->midi_view(); }
72         
73         void set_y_position_and_height (double, double);
74         
75         void redisplay_model();
76
77     GhostRegion* add_ghost (AutomationTimeAxisView&);
78
79         void add_note(const ARDOUR::Note& note, bool copy_note);
80         void resolve_note(uint8_t note_num, double end_time);
81
82         void begin_write();
83         void end_write();
84         void extend_active_notes();
85
86         void create_note_at(double x, double y, double dur);
87
88         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
89
90         /* This stuff is a bit boilerplatey ATM.  Work in progress. */
91
92         inline void start_remove_command() {
93                 if (!_delta_command)
94                         _delta_command = _model->new_delta_command();
95         }
96         
97         inline void start_delta_command() {
98                 if (!_delta_command)
99                         _delta_command = _model->new_delta_command();
100         }
101         
102         void command_add_note(ARDOUR::Note& note) {
103                 if (_delta_command)
104                         _delta_command->add(note);
105         }
106
107         void command_remove_note(ArdourCanvas::CanvasMidiEvent* ev) {
108                 if (_delta_command && ev->note()) {
109                         _delta_command->remove(*ev->note());
110                         ev->selected(true);
111                 }
112         }
113
114         void abort_command() {
115                 delete _delta_command;
116                 _delta_command = NULL;
117                 clear_selection();
118         }
119
120         void apply_command() {
121                 if (_delta_command) {
122                         _model->apply_command(_delta_command);
123                         _delta_command = NULL;
124                 }
125                 midi_view()->midi_track()->diskstream()->playlist_modified();
126         }
127         
128         void   note_entered(ArdourCanvas::CanvasMidiEvent* ev);
129         void   unique_select(ArdourCanvas::CanvasMidiEvent* ev);
130         void   note_selected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
131         void   note_deselected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
132         void   delete_selection();
133         size_t selection_size() { return _selection.size(); }
134
135         void move_selection(double dx, double dy);
136         void note_dropped(ArdourCanvas::CanvasMidiEvent* ev, double dt, uint8_t dnote);
137         
138         enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
139         MouseState mouse_state() const { return _mouse_state; }
140         
141   protected:
142
143     /* this constructor allows derived types
144        to specify their visibility requirements
145        to the TimeAxisViewItem parent class
146     */
147     
148     MidiRegionView (ArdourCanvas::Group *, 
149                         RouteTimeAxisView&,
150                         boost::shared_ptr<ARDOUR::MidiRegion>,
151                         double samples_per_unit,
152                         Gdk::Color& basic_color,
153                         TimeAxisViewItem::Visibility);
154     
155     void region_resized (ARDOUR::Change);
156
157     void set_flags (XMLNode *);
158     void store_flags ();
159     
160         void reset_width_dependent_items (double pixel_width);
161
162   private:
163
164         void clear_events();
165         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
166
167         bool canvas_event(GdkEvent* ev);
168         bool note_canvas_event(GdkEvent* ev);
169         
170         void clear_selection_except(ArdourCanvas::CanvasMidiEvent* ev);
171         void clear_selection() { clear_selection_except(NULL); }
172         void update_drag_selection(double last_x, double x, double last_y, double y);
173
174         double _default_note_length;
175
176         boost::shared_ptr<ARDOUR::MidiModel>        _model;
177         std::vector<ArdourCanvas::CanvasMidiEvent*> _events;
178         ArdourCanvas::CanvasNote**                  _active_notes;
179         ArdourCanvas::Group*                        _note_group;
180         ARDOUR::MidiModel::DeltaCommand*            _delta_command;
181                 
182         MouseState _mouse_state;
183         int _pressed_button;
184
185         typedef std::set<ArdourCanvas::CanvasMidiEvent*> Selection;
186         Selection _selection;
187 };
188
189 #endif /* __gtk_ardour_midi_region_view_h__ */