Committed underlay support (from Audun).
[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 set_frame_color();
76
77         void redisplay_model();
78
79         GhostRegion* add_ghost (TimeAxisView&);
80
81         void add_note(const boost::shared_ptr<ARDOUR::Note> note);
82         void resolve_note(uint8_t note_num, double end_time);
83
84         void begin_write();
85         void end_write();
86         void extend_active_notes();
87
88         void create_note_at(double x, double y, double dur);
89
90         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
91
92         /* This stuff is a bit boilerplatey ATM.  Work in progress. */
93
94         inline void start_remove_command() {
95                 if (!_delta_command)
96                         _delta_command = _model->new_delta_command();
97         }
98         
99         inline void start_delta_command() {
100                 if (!_delta_command)
101                         _delta_command = _model->new_delta_command();
102         }
103         
104         void command_add_note(const boost::shared_ptr<ARDOUR::Note> note) {
105                 if (_delta_command)
106                         _delta_command->add(note);
107         }
108
109         void command_remove_note(ArdourCanvas::CanvasMidiEvent* ev) {
110                 if (_delta_command && ev->note()) {
111                         _delta_command->remove(ev->note());
112                         ev->selected(true);
113                 }
114         }
115
116         void abort_command() {
117                 delete _delta_command;
118                 _delta_command = NULL;
119                 clear_selection();
120         }
121
122         void apply_command() {
123                 if (_delta_command) {
124                         _model->apply_command(_delta_command);
125                         _delta_command = NULL;
126                 }
127                 midi_view()->midi_track()->diskstream()->playlist_modified();
128         }
129         
130         void   note_entered(ArdourCanvas::CanvasMidiEvent* ev);
131         void   unique_select(ArdourCanvas::CanvasMidiEvent* ev);
132         void   note_selected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
133         void   note_deselected(ArdourCanvas::CanvasMidiEvent* ev, bool add);
134         void   delete_selection();
135         size_t selection_size() { return _selection.size(); }
136
137         void move_selection(double dx, double dy);
138         void note_dropped(ArdourCanvas::CanvasMidiEvent* ev, double dt, uint8_t dnote);
139         
140         enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
141         MouseState mouse_state() const { return _mouse_state; }
142         
143   protected:
144
145     /* this constructor allows derived types
146        to specify their visibility requirements
147        to the TimeAxisViewItem parent class
148     */
149     
150     MidiRegionView (ArdourCanvas::Group *, 
151                         RouteTimeAxisView&,
152                         boost::shared_ptr<ARDOUR::MidiRegion>,
153                         double samples_per_unit,
154                         Gdk::Color& basic_color,
155                         TimeAxisViewItem::Visibility);
156     
157     void region_resized (ARDOUR::Change);
158
159     void set_flags (XMLNode *);
160     void store_flags ();
161     
162         void reset_width_dependent_items (double pixel_width);
163
164   private:
165
166         void clear_events();
167         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
168
169         bool canvas_event(GdkEvent* ev);
170         bool note_canvas_event(GdkEvent* ev);
171         
172         void clear_selection_except(ArdourCanvas::CanvasMidiEvent* ev);
173         void clear_selection() { clear_selection_except(NULL); }
174         void update_drag_selection(double last_x, double x, double last_y, double y);
175
176         double _default_note_length;
177
178         boost::shared_ptr<ARDOUR::MidiModel>        _model;
179         std::vector<ArdourCanvas::CanvasMidiEvent*> _events;
180         ArdourCanvas::CanvasNote**                  _active_notes;
181         ArdourCanvas::Group*                        _note_group;
182         ARDOUR::MidiModel::DeltaCommand*            _delta_command;
183                 
184         MouseState _mouse_state;
185         int _pressed_button;
186
187         typedef std::set<ArdourCanvas::CanvasMidiEvent*> Selection;
188         Selection _selection;
189 };
190
191 #endif /* __gtk_ardour_midi_region_view_h__ */