Example code to load the x and <-> xpms for the mixer strip from files instead of...
[ardour.git] / gtk2_ardour / editor_canvas.cc
1 /*
2     Copyright (C) 2005 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     $Id$
19 */
20
21 #include <libgnomecanvasmm/init.h>
22 #include <jack/types.h>
23
24 #include <ardour/audioregion.h>
25
26 #include "ardour_ui.h"
27 #include "editor.h"
28 #include "waveview.h"
29 #include "simplerect.h"
30 #include "simpleline.h"
31 #include "imageframe.h"
32 #include "waveview_p.h"
33 #include "simplerect_p.h"
34 #include "simpleline_p.h"
35 #include "imageframe_p.h"
36 #include "canvas_impl.h"
37 #include "editing.h"
38 #include "rgb_macros.h"
39 #include "utils.h"
40 #include "time_axis_view.h"
41 #include "audio_time_axis.h"
42
43 #include "i18n.h"
44
45 using namespace std;
46 using namespace sigc;
47 using namespace ARDOUR;
48 using namespace Gtk;
49 using namespace Glib;
50 using namespace Gtkmm2ext;
51 using namespace Editing;
52
53 /* XXX this is a hack. it ought to be the maximum value of an jack_nframes_t */
54
55 const double max_canvas_coordinate = (double) JACK_MAX_FRAMES;
56
57 extern "C"
58 {
59
60 GType gnome_canvas_simpleline_get_type(void);
61 GType gnome_canvas_simplerect_get_type(void);
62 GType gnome_canvas_waveview_get_type(void);
63 GType gnome_canvas_imageframe_get_type(void);
64
65 }
66
67 static void ardour_canvas_type_init() 
68 {
69         // Map gtypes to gtkmm wrapper-creation functions:
70         
71         Glib::wrap_register(gnome_canvas_simpleline_get_type(), &Gnome::Canvas::SimpleLine_Class::wrap_new);
72         Glib::wrap_register(gnome_canvas_simplerect_get_type(), &Gnome::Canvas::SimpleRect_Class::wrap_new);
73         Glib::wrap_register(gnome_canvas_waveview_get_type(), &Gnome::Canvas::WaveView_Class::wrap_new);
74         Glib::wrap_register(gnome_canvas_imageframe_get_type(), &Gnome::Canvas::ImageFrame_Class::wrap_new);
75         
76         // Register the gtkmm gtypes:
77
78         (void) Gnome::Canvas::WaveView::get_type();
79         (void) Gnome::Canvas::SimpleLine::get_type();
80         (void) Gnome::Canvas::SimpleRect::get_type();
81         (void) Gnome::Canvas::ImageFrame::get_type();
82
83
84 void
85 Editor::initialize_canvas ()
86 {
87         ArdourCanvas::init ();
88         ardour_canvas_type_init ();
89
90         /* don't try to center the canvas */
91
92         track_canvas.set_center_scroll_region (false);
93
94         track_canvas.signal_event().connect (bind (mem_fun (*this, &Editor::track_canvas_event), (ArdourCanvas::Item*) 0));
95         track_canvas.set_name ("EditorMainCanvas");
96         track_canvas.add_events (Gdk::POINTER_MOTION_HINT_MASK|Gdk::SCROLL_MASK);
97         track_canvas.signal_leave_notify_event().connect (mem_fun(*this, &Editor::left_track_canvas));
98         track_canvas.set_flags (CAN_FOCUS);
99
100         /* set up drag-n-drop */
101
102         vector<TargetEntry> target_table;
103         
104         // Drag-N-Drop from the region list can generate this target
105         target_table.push_back (TargetEntry ("regions"));
106
107         target_table.push_back (TargetEntry ("text/plain"));
108         target_table.push_back (TargetEntry ("text/uri-list"));
109         target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
110
111         track_canvas.drag_dest_set (target_table);
112         track_canvas.signal_drag_data_received().connect (mem_fun(*this, &Editor::track_canvas_drag_data_received));
113
114         /* stuff for the verbose canvas cursor */
115
116         Pango::FontDescription font = get_font_for_style (N_("VerboseCanvasCursor"));
117
118         verbose_canvas_cursor = new ArdourCanvas::Text (*track_canvas.root());
119         verbose_canvas_cursor->property_font_desc() = font;
120         verbose_canvas_cursor->property_anchor() = ANCHOR_NW;
121         verbose_canvas_cursor->property_fill_color_rgba() = color_map[cVerboseCanvasCursor];
122         
123         verbose_cursor_visible = false;
124         
125         /* a group to hold time (measure) lines */
126         
127         time_line_group = new ArdourCanvas::Group (*track_canvas.root(), 0.0, 0.0);
128         cursor_group = new ArdourCanvas::Group (*track_canvas.root(), 0.0, 0.0);
129         
130         time_canvas.set_name ("EditorTimeCanvas");
131         time_canvas.add_events (Gdk::POINTER_MOTION_HINT_MASK);
132         time_canvas.set_flags (CAN_FOCUS);
133         
134         meter_group = new ArdourCanvas::Group (*time_canvas.root(), 0.0, 0.0);
135         tempo_group = new ArdourCanvas::Group (*time_canvas.root(), 0.0, timebar_height);
136         marker_group = new ArdourCanvas::Group (*time_canvas.root(), 0.0, timebar_height * 2.0);
137         range_marker_group = new ArdourCanvas::Group (*time_canvas.root(), 0.0, timebar_height * 3.0);
138         transport_marker_group = new ArdourCanvas::Group (*time_canvas.root(), 0.0, timebar_height * 4.0);
139         
140         tempo_bar = new ArdourCanvas::SimpleRect (*tempo_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
141         tempo_bar->property_fill_color_rgba() = color_map[cTempoBar];
142         tempo_bar->property_outline_pixels() = 0;
143         
144         meter_bar = new ArdourCanvas::SimpleRect (*meter_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
145         meter_bar->property_fill_color_rgba() = color_map[cMeterBar];
146         meter_bar->property_outline_pixels() = 0;
147         
148         marker_bar = new ArdourCanvas::SimpleRect (*marker_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
149         marker_bar->property_fill_color_rgba() = color_map[cMarkerBar];
150         marker_bar->property_outline_pixels() = 0;
151         
152         range_marker_bar = new ArdourCanvas::SimpleRect (*range_marker_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
153         range_marker_bar->property_fill_color_rgba() = color_map[cRangeMarkerBar];
154         range_marker_bar->property_outline_pixels() = 0;
155         
156         transport_marker_bar = new ArdourCanvas::SimpleRect (*transport_marker_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
157         transport_marker_bar->property_fill_color_rgba() = color_map[cTransportMarkerBar];
158         transport_marker_bar->property_outline_pixels() = 0;
159         
160         range_bar_drag_rect = new ArdourCanvas::SimpleRect (*range_marker_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
161         range_bar_drag_rect->property_fill_color_rgba() = color_map[cRangeDragBarRectFill];
162         range_bar_drag_rect->property_outline_color_rgba() = color_map[cRangeDragBarRect];
163         range_bar_drag_rect->property_outline_pixels() = 0;
164         range_bar_drag_rect->hide ();
165         
166         transport_bar_drag_rect = new ArdourCanvas::SimpleRect (*transport_marker_group, 0.0, 0.0, max_canvas_coordinate, timebar_height);
167         transport_bar_drag_rect ->property_fill_color_rgba() = color_map[cTransportDragRectFill];
168         transport_bar_drag_rect->property_outline_color_rgba() = color_map[cTransportDragRect];
169         transport_bar_drag_rect->property_outline_pixels() = 0;
170         transport_bar_drag_rect->hide ();
171         
172         marker_drag_line_points.push_back(Gnome::Art::Point(0.0, 0.0));
173         marker_drag_line_points.push_back(Gnome::Art::Point(0.0, 0.0));
174
175         marker_drag_line = new ArdourCanvas::Line (*track_canvas.root());
176         marker_drag_line->property_width_pixels() = 1;
177         marker_drag_line->property_fill_color_rgba() = color_map[cMarkerDragLine];
178         marker_drag_line->property_points() = marker_drag_line_points;
179         marker_drag_line->hide();
180
181         range_marker_drag_rect = new ArdourCanvas::SimpleRect (*track_canvas.root(), 0.0, 0.0, 0.0, 0.0);
182         range_marker_drag_rect->property_fill_color_rgba() = color_map[cRangeDragRectFill];
183         range_marker_drag_rect->property_outline_color_rgba() = color_map[cRangeDragRect];
184         range_marker_drag_rect->hide ();
185         
186         transport_loop_range_rect = new ArdourCanvas::SimpleRect (*time_line_group, 0.0, 0.0, 0.0, 0.0);
187         transport_loop_range_rect->property_fill_color_rgba() = color_map[cTransportLoopRectFill];
188         transport_loop_range_rect->property_outline_color_rgba() = color_map[cTransportLoopRect];
189         transport_loop_range_rect->property_outline_pixels() = 1;
190         transport_loop_range_rect->hide();
191
192         transport_punch_range_rect = new ArdourCanvas::SimpleRect (*time_line_group, 0.0, 0.0, 0.0, 0.0);
193         transport_punch_range_rect->property_fill_color_rgba() = color_map[cTransportPunchRectFill];
194         transport_punch_range_rect->property_outline_color_rgba() = color_map[cTransportPunchRect];
195         transport_punch_range_rect->property_outline_pixels() = 0;
196         transport_punch_range_rect->hide();
197         
198         transport_loop_range_rect->lower_to_bottom (); // loop on the bottom
199
200         transport_punchin_line = new ArdourCanvas::SimpleLine (*time_line_group);
201         transport_punchin_line->property_x1() = 0.0;
202         transport_punchin_line->property_y1() = 0.0;
203         transport_punchin_line->property_x2() = 0.0;
204         transport_punchin_line->property_y2() = 0.0;
205         transport_punchin_line->property_color_rgba() = color_map[cPunchInLine];
206         transport_punchin_line->hide ();
207         
208         transport_punchout_line  = new ArdourCanvas::SimpleLine (*time_line_group);
209         transport_punchout_line->property_x1() = 0.0;
210         transport_punchout_line->property_y1() = 0.0;
211         transport_punchout_line->property_x2() = 0.0;
212         transport_punchout_line->property_y2() = 0.0;
213         transport_punchout_line->property_color_rgba() = color_map[cPunchOutLine];
214         transport_punchout_line->hide();
215         
216         // used to show zoom mode active zooming
217         zoom_rect = new ArdourCanvas::SimpleRect (*track_canvas.root(), 0.0, 0.0, 0.0, 0.0);
218         zoom_rect->property_fill_color_rgba() = color_map[cZoomRectFill];
219         zoom_rect->property_outline_color_rgba() = color_map[cZoomRect];
220         zoom_rect->property_outline_pixels() = 1;
221         zoom_rect->hide();
222         
223         zoom_rect->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_zoom_rect_event), (ArdourCanvas::Item*) 0));
224         
225         // used as rubberband rect
226         rubberband_rect = new ArdourCanvas::SimpleRect (*track_canvas.root(), 0.0, 0.0, 0.0, 0.0);
227         rubberband_rect->property_outline_color_rgba() = color_map[cRubberBandRect];
228         rubberband_rect->property_fill_color_rgba() = (guint32) color_map[cRubberBandRectFill];
229         rubberband_rect->property_outline_pixels() = 1;
230         rubberband_rect->hide();
231         
232         tempo_bar->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_tempo_bar_event), tempo_bar));
233         meter_bar->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_meter_bar_event), meter_bar));
234         marker_bar->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_marker_bar_event), marker_bar));
235         range_marker_bar->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_range_marker_bar_event), range_marker_bar));
236         transport_marker_bar->signal_event().connect (bind (mem_fun (*this, &Editor::canvas_transport_marker_bar_event), transport_marker_bar));
237         
238         /* separator lines */
239         
240         tempo_line = new ArdourCanvas::SimpleLine (*tempo_group, 0, timebar_height, max_canvas_coordinate, timebar_height);
241         tempo_line->property_color_rgba() = RGBA_TO_UINT (0,0,0,255);
242
243         meter_line = new ArdourCanvas::SimpleLine (*meter_group, 0, timebar_height, max_canvas_coordinate, timebar_height);
244         meter_line->property_color_rgba() = RGBA_TO_UINT (0,0,0,255);
245
246         marker_line = new ArdourCanvas::SimpleLine (*marker_group, 0, timebar_height, max_canvas_coordinate, timebar_height);
247         marker_line->property_color_rgba() = RGBA_TO_UINT (0,0,0,255);
248         
249         range_marker_line = new ArdourCanvas::SimpleLine (*range_marker_group, 0, timebar_height, max_canvas_coordinate, timebar_height);
250         range_marker_line->property_color_rgba() = RGBA_TO_UINT (0,0,0,255);
251
252         transport_marker_line = new ArdourCanvas::SimpleLine (*transport_marker_group, 0, timebar_height, max_canvas_coordinate, timebar_height);
253         transport_marker_line->property_color_rgba() = RGBA_TO_UINT (0,0,0,255);
254
255         ZoomChanged.connect (bind (mem_fun(*this, &Editor::update_loop_range_view), false));
256         ZoomChanged.connect (bind (mem_fun(*this, &Editor::update_punch_range_view), false));
257         
258         double time_height = timebar_height * 5;
259         double time_width = FLT_MAX/frames_per_unit;
260         time_canvas.set_scroll_region(0.0, 0.0, time_width, time_height);
261         
262         edit_cursor = new Cursor (*this, "blue", &Editor::canvas_edit_cursor_event);
263         playhead_cursor = new Cursor (*this, "red", &Editor::canvas_playhead_cursor_event);
264         
265         track_canvas.signal_size_allocate().connect (mem_fun(*this, &Editor::track_canvas_allocate));
266 }
267
268 void
269 Editor::track_canvas_allocate (Gtk::Allocation alloc)
270 {
271         static bool first_time = true;
272
273         canvas_width = alloc.get_width();
274         canvas_height = alloc.get_height();
275
276         if (session == 0 && !ARDOUR_UI::instance()->will_create_new_session_automatically()) {
277
278                 /* this mess of code is here to find out how wide this text is and
279                    position the message in the center of the editor window.
280                 */
281                         
282                 int pixel_height;
283                 int pixel_width;
284                 
285                 ustring msg = string_compose ("<span face=\"sans\" style=\"normal\" weight=\"bold\" size=\"x-large\">%1%2</span>",
286                                            _("Start a new session\n"), _("via Session menu"));
287
288                 RefPtr<Pango::Layout> layout = create_pango_layout (msg);
289                 Pango::FontDescription font = get_font_for_style (N_("FirstActionMessage"));
290                 layout->get_pixel_size (pixel_width, pixel_height);
291                         
292                 if (first_action_message == 0) {
293                         
294                         first_action_message = new ArdourCanvas::Text (*track_canvas.root());
295                         first_action_message->property_font_desc() = font;
296                         first_action_message->property_fill_color_rgba() = color_map[cFirstActionMessage];
297                         first_action_message->property_x() = (canvas_width - pixel_width) / 2.0;
298                         first_action_message->property_y() = (canvas_height/2.0) - pixel_height;
299                         first_action_message->property_anchor() = ANCHOR_NORTH_WEST;
300                         first_action_message->property_markup() = msg;
301                         
302                 } else {
303
304                         /* center it */
305                         first_action_message->property_x() = (canvas_width - pixel_width) / 2.0;
306                         first_action_message->property_y() = (canvas_height/2.0) - pixel_height;
307                 }
308         }
309
310         zoom_range_clock.set ((jack_nframes_t) floor ((canvas_width * frames_per_unit)));
311         edit_cursor->set_position (edit_cursor->current_frame);
312         playhead_cursor->set_position (playhead_cursor->current_frame);
313
314         reset_scrolling_region ();
315
316         if (edit_cursor) edit_cursor->set_length (canvas_height);
317         if (playhead_cursor) playhead_cursor->set_length (canvas_height);
318
319         if (marker_drag_line) {
320                 marker_drag_line_points.back().set_x(canvas_height);
321                 marker_drag_line->property_points() = marker_drag_line_points;
322         }
323
324         if (range_marker_drag_rect) {
325                 range_marker_drag_rect->property_y1() = 0.0;
326                 range_marker_drag_rect->property_y2() = canvas_height;
327         }
328
329         if (transport_loop_range_rect) {
330                 transport_loop_range_rect->property_y1() = 0.0;
331                 transport_loop_range_rect->property_y2() = canvas_height;
332         }
333
334         if (transport_punch_range_rect) {
335                 transport_punch_range_rect->property_y1() = 0.0;
336                 transport_punch_range_rect->property_y2() = canvas_height;
337         }
338
339         if (transport_punchin_line) {
340                 transport_punchin_line->property_y1() = 0.0;
341                 transport_punchin_line->property_y2() = canvas_height;
342         }
343
344         if (transport_punchout_line) {
345                 transport_punchout_line->property_y1() = 0.0;
346                 transport_punchout_line->property_y2() = canvas_height;
347         }
348                 
349         update_fixed_rulers ();
350
351         if (is_visible() && first_time) {
352                 tempo_map_changed (Change (0));
353                 first_time = false;
354         } else {
355                 redisplay_tempo ();
356         }
357         
358         Resized (); /* EMIT_SIGNAL */
359 }
360
361 void
362 Editor::reset_scrolling_region (Gtk::Allocation* alloc)
363 {
364         TreeModel::Children rows = route_display_model->children();
365         TreeModel::Children::iterator i;
366         double pos;
367
368         for (pos = 0, i = rows.begin(); i != rows.end(); ++i) {
369                 TimeAxisView *tv = (*i)[route_display_columns.tv];
370                 if (tv != 0) {
371                         pos += tv->effective_height;
372                         pos += track_spacing;
373                 }
374         }
375
376         double last_canvas_unit = ceil ((double) max_frames / frames_per_unit);
377         track_canvas.set_scroll_region (0.0, 0.0, max (last_canvas_unit, canvas_width), pos);
378
379         // XXX what is the correct height value for the time canvas ? this overstates it
380         time_canvas.set_scroll_region ( 0.0, 0.0, max (last_canvas_unit, canvas_width), canvas_height);
381
382         controls_layout.queue_resize();
383
384 }
385
386 void
387 Editor::controls_layout_size_request (Requisition* req)
388 {
389         TreeModel::Children rows = route_display_model->children();
390         TreeModel::Children::iterator i;
391         double pos;
392
393         for (pos = 0, i = rows.begin(); i != rows.end(); ++i) {
394                 TimeAxisView *tv = (*i)[route_display_columns.tv];
395                 if (tv != 0) {
396                         pos += tv->effective_height;
397                         pos += track_spacing;
398                 }
399         }
400
401         RefPtr<Gdk::Screen> screen = get_screen();
402
403         if (!screen) {
404                 screen = Gdk::Screen::get_default();
405         }
406
407         /* never let the width of the controls area shrink horizontally */
408
409         edit_controls_vbox.check_resize();
410
411         req->width = max (edit_controls_vbox.get_width(),  controls_layout.get_width());
412         req->height = min ((gint) pos, (screen->get_height() - 400));
413
414         /* this one is important: it determines how big the layout thinks it really is, as 
415            opposed to what it displays on the screen
416         */
417
418         controls_layout.set_size (req->width, (gint) pos);
419 }
420
421 bool
422 Editor::track_canvas_map_handler (GdkEventAny* ev)
423 {
424         track_canvas.get_window()->set_cursor (*current_canvas_cursor);
425         return false;
426 }
427
428 bool
429 Editor::time_canvas_map_handler (GdkEventAny* ev)
430 {
431         time_canvas.get_window()->set_cursor (*timebar_cursor);
432         return false;
433 }
434
435 void  
436 Editor::track_canvas_drag_data_received (const RefPtr<Gdk::DragContext>& context,
437                                          int x, int y, 
438                                          const SelectionData& data,
439                                          guint info, guint time)
440 {
441         if (data.get_target() == "regions") {
442                 drop_regions (context, x, y, data, info, time);
443         } else {
444                 drop_paths (context, x, y, data, info, time);
445         }
446 }
447
448 void
449 Editor::drop_paths (const RefPtr<Gdk::DragContext>& context,
450                     int x, int y, 
451                     const SelectionData& data,
452                     guint info, guint time)
453 {
454         TimeAxisView* tvp;
455         AudioTimeAxisView* tv;
456         double cy;
457         vector<string> paths;
458         string spath;
459         GdkEvent ev;
460         jack_nframes_t frame;
461
462         if (convert_drop_to_paths (paths, context, x, y, data, info, time)) {
463                 goto out;
464         }
465
466         /* D-n-D coordinates are window-relative, so convert to "world" coordinates
467          */
468
469         double wx;
470         double wy;
471
472         track_canvas.window_to_world (x, y, wx, wy);
473         wx += horizontal_adjustment.get_value();
474         wy += vertical_adjustment.get_value();
475         
476         ev.type = GDK_BUTTON_RELEASE;
477         ev.button.x = wx;
478         ev.button.y = wy;
479
480         frame = event_frame (&ev, 0, &cy);
481
482         snap_to (frame);
483
484         if ((tvp = trackview_by_y_position (cy)) == 0) {
485
486                 /* drop onto canvas background: create a new track */
487
488                 insert_paths_as_new_tracks (paths, false);
489
490                 
491         } else if ((tv = dynamic_cast<AudioTimeAxisView*>(tvp)) != 0) {
492
493                 /* check that its an audio track, not a bus */
494
495                 if (tv->get_diskstream()) {
496
497                         for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
498                                 insert_sndfile_into (*p, true, tv, frame);
499                         }
500                 }
501
502         }
503
504   out:
505         context->drag_finish (true, false, time);
506 }
507
508 void
509 Editor::drop_regions (const RefPtr<Gdk::DragContext>& context,
510                       int x, int y, 
511                       const SelectionData& data,
512                       guint info, guint time)
513 {
514         const DnDTreeView::SerializedObjectPointers* sr = reinterpret_cast<const DnDTreeView::SerializedObjectPointers*> (data.get_data());
515
516         for (uint32_t i = 0; i < sr->cnt; ++i) {
517
518                 Region* r = reinterpret_cast<Region*> (sr->ptr[i]);
519                 AudioRegion* ar;
520
521                 if ((ar = dynamic_cast<AudioRegion*>(r)) != 0) {
522                         insert_region_list_drag (*ar, x, y);
523                 }
524         }
525
526         context->drag_finish (true, false, time);
527 }