drastic, deep and wide changes to make RouteGroup use boost::shared_ptr<Route> and...
[ardour.git] / gtk2_ardour / editor.cc
1 /*
2     Copyright (C) 2000-2009 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
20 /* Note: public Editor methods are documented in public_editor.h */
21
22 #define __STDC_LIMIT_MACROS 1
23 #include <stdint.h>
24 #include <unistd.h>
25 #include <cstdlib>
26 #include <cmath>
27 #include <string>
28 #include <algorithm>
29 #include <map>
30
31 #include "ardour_ui.h"
32 /*
33  * ardour_ui.h include was moved to the top of the list
34  * due to a conflicting definition of 'Style' between
35  * Apple's MacTypes.h and BarController.
36  */
37
38 #include <boost/none.hpp>
39
40 #include <sigc++/bind.h>
41
42 #include "pbd/convert.h"
43 #include "pbd/error.h"
44 #include "pbd/enumwriter.h"
45 #include "pbd/memento_command.h"
46 #include "pbd/unknown_type.h"
47
48 #include <glibmm/miscutils.h>
49 #include <gtkmm/image.h>
50 #include <gdkmm/color.h>
51 #include <gdkmm/bitmap.h>
52
53 #include <gtkmm2ext/grouped_buttons.h>
54 #include <gtkmm2ext/gtk_ui.h>
55 #include <gtkmm2ext/tearoff.h>
56 #include <gtkmm2ext/utils.h>
57 #include <gtkmm2ext/window_title.h>
58 #include <gtkmm2ext/choice.h>
59 #include <gtkmm2ext/cell_renderer_pixbuf_toggle.h>
60
61 #include "ardour/audio_diskstream.h"
62 #include "ardour/audio_track.h"
63 #include "ardour/audioplaylist.h"
64 #include "ardour/audioregion.h"
65 #include "ardour/location.h"
66 #include "ardour/midi_region.h"
67 #include "ardour/plugin_manager.h"
68 #include "ardour/profile.h"
69 #include "ardour/route_group.h"
70 #include "ardour/session_directory.h"
71 #include "ardour/session_route.h"
72 #include "ardour/session_state_utils.h"
73 #include "ardour/tempo.h"
74 #include "ardour/utils.h"
75 #include "ardour/session_playlists.h"
76
77 #include "control_protocol/control_protocol.h"
78
79 #include "editor.h"
80 #include "keyboard.h"
81 #include "marker.h"
82 #include "playlist_selector.h"
83 #include "audio_region_view.h"
84 #include "rgb_macros.h"
85 #include "selection.h"
86 #include "audio_streamview.h"
87 #include "time_axis_view.h"
88 #include "audio_time_axis.h"
89 #include "utils.h"
90 #include "crossfade_view.h"
91 #include "canvas-noevent-text.h"
92 #include "editing.h"
93 #include "public_editor.h"
94 #include "crossfade_edit.h"
95 #include "canvas_impl.h"
96 #include "actions.h"
97 #include "sfdb_ui.h"
98 #include "gui_thread.h"
99 #include "simpleline.h"
100 #include "rhythm_ferret.h"
101 #include "actions.h"
102 #include "tempo_lines.h"
103 #include "analysis_window.h"
104 #include "bundle_manager.h"
105 #include "global_port_matrix.h"
106 #include "editor_drag.h"
107 #include "editor_group_tabs.h"
108 #include "automation_time_axis.h"
109 #include "editor_routes.h"
110 #include "midi_time_axis.h"
111 #include "mixer_strip.h"
112 #include "editor_route_groups.h"
113 #include "editor_regions.h"
114 #include "editor_locations.h"
115 #include "editor_snapshots.h"
116
117 #include "i18n.h"
118
119 #ifdef WITH_CMT
120 #include "imageframe_socket_handler.h"
121 #endif
122
123 using namespace std;
124 using namespace sigc;
125 using namespace ARDOUR;
126 using namespace PBD;
127 using namespace Gtk;
128 using namespace Glib;
129 using namespace Gtkmm2ext;
130 using namespace Editing;
131
132 using PBD::internationalize;
133 using PBD::atoi;
134 using Gtkmm2ext::Keyboard;
135
136 const double Editor::timebar_height = 15.0;
137
138 #include "editor_xpms"
139
140 static const gchar *_snap_type_strings[] = {
141         N_("CD Frames"),
142         N_("Timecode Frames"),
143         N_("Timecode Seconds"),
144         N_("Timecode Minutes"),
145         N_("Seconds"),
146         N_("Minutes"),
147         N_("Beats/32"),
148         N_("Beats/16"),
149         N_("Beats/8"),
150         N_("Beats/4"),
151         N_("Beats/3"),
152         N_("Beats"),
153         N_("Bars"),
154         N_("Marks"),
155         N_("Region starts"),
156         N_("Region ends"),
157         N_("Region syncs"),
158         N_("Region bounds"),
159         0
160 };
161
162 static const gchar *_snap_mode_strings[] = {
163         N_("No Grid"),
164         N_("Grid"),
165         N_("Magnetic"),
166         0
167 };
168
169 static const gchar *_edit_point_strings[] = {
170         N_("Playhead"),
171         N_("Marker"),
172         N_("Mouse"),
173         0
174 };
175
176 static const gchar *_zoom_focus_strings[] = {
177         N_("Left"),
178         N_("Right"),
179         N_("Center"),
180         N_("Playhead"),
181         N_("Mouse"),
182         N_("Edit point"),
183         0
184 };
185
186 #ifdef USE_RUBBERBAND
187 static const gchar *_rb_opt_strings[] = {
188         N_("Mushy"),
189         N_("Smooth"),
190         N_("Balanced multitimbral mixture"),
191         N_("Unpitched percussion with stable notes"),
192         N_("Crisp monophonic instrumental"),
193         N_("Unpitched solo percussion"),
194         0
195 };
196 #endif
197
198 /* Soundfile  drag-n-drop */
199
200 Gdk::Cursor* Editor::cross_hair_cursor = 0;
201 Gdk::Cursor* Editor::selector_cursor = 0;
202 Gdk::Cursor* Editor::trimmer_cursor = 0;
203 Gdk::Cursor* Editor::grabber_cursor = 0;
204 Gdk::Cursor* Editor::grabber_edit_point_cursor = 0;
205 Gdk::Cursor* Editor::zoom_cursor = 0;
206 Gdk::Cursor* Editor::time_fx_cursor = 0;
207 Gdk::Cursor* Editor::fader_cursor = 0;
208 Gdk::Cursor* Editor::speaker_cursor = 0;
209 Gdk::Cursor* Editor::midi_pencil_cursor = 0;
210 Gdk::Cursor* Editor::midi_select_cursor = 0;
211 Gdk::Cursor* Editor::midi_resize_cursor = 0;
212 Gdk::Cursor* Editor::midi_erase_cursor = 0;
213 Gdk::Cursor* Editor::wait_cursor = 0;
214 Gdk::Cursor* Editor::timebar_cursor = 0;
215 Gdk::Cursor* Editor::transparent_cursor = 0;
216
217 void
218 show_me_the_size (Requisition* r, const char* what)
219 {
220         cerr << "size of " << what << " = " << r->width << " x " << r->height << endl;
221 }
222
223 Editor::Editor ()
224           /* time display buttons */
225         : minsec_label (_("Mins:Secs"))
226         , bbt_label (_("Bars:Beats"))
227         , timecode_label (_("Timecode"))
228         , frame_label (_("Samples"))
229         , tempo_label (_("Tempo"))
230         , meter_label (_("Meter"))
231         , mark_label (_("Location Markers"))
232         , range_mark_label (_("Range Markers"))
233         , transport_mark_label (_("Loop/Punch Ranges"))
234         , cd_mark_label (_("CD Markers"))
235         , edit_packer (4, 4, true)
236
237           /* the values here don't matter: layout widgets
238              reset them as needed.
239           */
240
241         , vertical_adjustment (0.0, 0.0, 10.0, 400.0)
242         , horizontal_adjustment (0.0, 0.0, 20.0, 1200.0)
243
244           /* tool bar related */
245
246         , zoom_range_clock (X_("zoomrange"), false, X_("ZoomRangeClock"), true, false, true)
247
248         , toolbar_selection_clock_table (2,3)
249
250         , automation_mode_button (_("mode"))
251         , global_automation_button (_("automation"))
252
253         , midi_panic_button (_("Panic"))
254
255 #ifdef WITH_CMT
256         , image_socket_listener(0)
257 #endif
258
259           /* nudge */
260
261         , nudge_clock (X_("nudge"), false, X_("NudgeClock"), true, false, true)
262         , meters_running(false)
263         , _pending_locate_request (false)
264
265 {
266         constructed = false;
267
268         /* we are a singleton */
269
270         PublicEditor::_instance = this;
271
272         session = 0;
273         _have_idled = false;
274
275         selection = new Selection (this);
276         cut_buffer = new Selection (this);
277
278         clicked_regionview = 0;
279         clicked_axisview = 0;
280         clicked_routeview = 0;
281         clicked_crossfadeview = 0;
282         clicked_control_point = 0;
283         last_update_frame = 0;
284         _drag = 0;
285         current_mixer_strip = 0;
286         current_bbt_points = 0;
287         tempo_lines = 0;
288
289         snap_type_strings =  I18N (_snap_type_strings);
290         snap_mode_strings =  I18N (_snap_mode_strings);
291         zoom_focus_strings = I18N (_zoom_focus_strings);
292         edit_point_strings = I18N (_edit_point_strings);
293 #ifdef USE_RUBBERBAND
294         rb_opt_strings = I18N (_rb_opt_strings);
295 #endif
296
297         snap_threshold = 5.0;
298         bbt_beat_subdivision = 4;
299         _canvas_width = 0;
300         _canvas_height = 0;
301         last_autoscroll_x = 0;
302         last_autoscroll_y = 0;
303         autoscroll_active = false;
304         autoscroll_timeout_tag = -1;
305         interthread_progress_window = 0;
306         logo_item = 0;
307
308         analysis_window = 0;
309
310         current_interthread_info = 0;
311         _show_measures = true;
312         _show_waveforms_recording = true;
313         show_gain_after_trim = false;
314         verbose_cursor_on = true;
315         route_removal = false;
316         last_item_entered = 0;
317         last_item_entered_n = 0;
318
319         have_pending_keyboard_selection = false;
320         _follow_playhead = true;
321         _xfade_visibility = true;
322         editor_ruler_menu = 0;
323         no_ruler_shown_update = false;
324         marker_menu = 0;
325         start_end_marker_menu = 0;
326         range_marker_menu = 0;
327         marker_menu_item = 0;
328         tm_marker_menu = 0;
329         transport_marker_menu = 0;
330         new_transport_marker_menu = 0;
331         editor_mixer_strip_width = Wide;
332         show_editor_mixer_when_tracks_arrive = false;
333         region_edit_menu_split_multichannel_item = 0;
334         region_edit_menu_split_item = 0;
335         temp_location = 0;
336         leftmost_frame = 0;
337         current_stepping_trackview = 0;
338         entered_track = 0;
339         entered_regionview = 0;
340         entered_marker = 0;
341         clear_entered_track = false;
342         _new_regionviews_show_envelope = false;
343         current_timefx = 0;
344         playhead_cursor = 0;
345         button_release_can_deselect = true;
346         _dragging_playhead = false;
347         _dragging_edit_point = false;
348         select_new_marker = false;
349         rhythm_ferret = 0;
350         _bundle_manager = 0;
351         for (ARDOUR::DataType::iterator i = ARDOUR::DataType::begin(); i != ARDOUR::DataType::end(); ++i) {
352                 _global_port_matrix[*i] = 0;
353         }
354         allow_vertical_scroll = false;
355         no_save_visual = false;
356         resize_idle_id = -1;
357
358         scrubbing_direction = 0;
359
360         sfbrowser = 0;
361
362         location_marker_color = ARDOUR_UI::config()->canvasvar_LocationMarker.get();
363         location_range_color = ARDOUR_UI::config()->canvasvar_LocationRange.get();
364         location_cd_marker_color = ARDOUR_UI::config()->canvasvar_LocationCDMarker.get();
365         location_loop_color = ARDOUR_UI::config()->canvasvar_LocationLoop.get();
366         location_punch_color = ARDOUR_UI::config()->canvasvar_LocationPunch.get();
367
368         _edit_point = EditAtMouse;
369         _internal_editing = false;
370         current_canvas_cursor = 0;
371
372         frames_per_unit = 2048; /* too early to use reset_zoom () */
373
374         zoom_focus = ZoomFocusLeft;
375         set_zoom_focus (ZoomFocusLeft);
376         zoom_range_clock.ValueChanged.connect (mem_fun(*this, &Editor::zoom_adjustment_changed));
377
378         bbt_label.set_name ("EditorTimeButton");
379         bbt_label.set_size_request (-1, (int)timebar_height);
380         bbt_label.set_alignment (1.0, 0.5);
381         bbt_label.set_padding (5,0);
382         bbt_label.hide ();
383         bbt_label.set_no_show_all();
384         minsec_label.set_name ("EditorTimeButton");
385         minsec_label.set_size_request (-1, (int)timebar_height);
386         minsec_label.set_alignment (1.0, 0.5);
387         minsec_label.set_padding (5,0);
388         minsec_label.hide ();
389         minsec_label.set_no_show_all();
390         timecode_label.set_name ("EditorTimeButton");
391         timecode_label.set_size_request (-1, (int)timebar_height);
392         timecode_label.set_alignment (1.0, 0.5);
393         timecode_label.set_padding (5,0);
394         timecode_label.hide ();
395         timecode_label.set_no_show_all();
396         frame_label.set_name ("EditorTimeButton");
397         frame_label.set_size_request (-1, (int)timebar_height);
398         frame_label.set_alignment (1.0, 0.5);
399         frame_label.set_padding (5,0);
400         frame_label.hide ();
401         frame_label.set_no_show_all();
402
403         tempo_label.set_name ("EditorTimeButton");
404         tempo_label.set_size_request (-1, (int)timebar_height);
405         tempo_label.set_alignment (1.0, 0.5);
406         tempo_label.set_padding (5,0);
407         tempo_label.hide();
408         tempo_label.set_no_show_all();
409         meter_label.set_name ("EditorTimeButton");
410         meter_label.set_size_request (-1, (int)timebar_height);
411         meter_label.set_alignment (1.0, 0.5);
412         meter_label.set_padding (5,0);
413         meter_label.hide();
414         meter_label.set_no_show_all();
415         mark_label.set_name ("EditorTimeButton");
416         mark_label.set_size_request (-1, (int)timebar_height);
417         mark_label.set_alignment (1.0, 0.5);
418         mark_label.set_padding (5,0);
419         mark_label.hide();
420         mark_label.set_no_show_all();
421         cd_mark_label.set_name ("EditorTimeButton");
422         cd_mark_label.set_size_request (-1, (int)timebar_height);
423         cd_mark_label.set_alignment (1.0, 0.5);
424         cd_mark_label.set_padding (5,0);
425         cd_mark_label.hide();
426         cd_mark_label.set_no_show_all();
427         range_mark_label.set_name ("EditorTimeButton");
428         range_mark_label.set_size_request (-1, (int)timebar_height);
429         range_mark_label.set_alignment (1.0, 0.5);
430         range_mark_label.set_padding (5,0);
431         range_mark_label.hide();
432         range_mark_label.set_no_show_all();
433         transport_mark_label.set_name ("EditorTimeButton");
434         transport_mark_label.set_size_request (-1, (int)timebar_height);
435         transport_mark_label.set_alignment (1.0, 0.5);
436         transport_mark_label.set_padding (5,0);
437         transport_mark_label.hide();
438         transport_mark_label.set_no_show_all();
439
440         initialize_rulers ();
441         _summary = new EditorSummary (this);
442         initialize_canvas ();
443
444         selection->TimeChanged.connect (mem_fun(*this, &Editor::time_selection_changed));
445         selection->TracksChanged.connect (mem_fun(*this, &Editor::track_selection_changed));
446         editor_regions_selection_changed_connection = selection->RegionsChanged.connect (mem_fun(*this, &Editor::region_selection_changed));
447         selection->PointsChanged.connect (mem_fun(*this, &Editor::point_selection_changed));
448         selection->MarkersChanged.connect (mem_fun(*this, &Editor::marker_selection_changed));
449
450         edit_controls_vbox.set_spacing (0);
451         horizontal_adjustment.signal_value_changed().connect (mem_fun(*this, &Editor::scroll_canvas_horizontally), false);
452         vertical_adjustment.signal_value_changed().connect (mem_fun(*this, &Editor::tie_vertical_scrolling), true);
453         track_canvas->signal_map_event().connect (mem_fun (*this, &Editor::track_canvas_map_handler));
454
455         HBox* h = manage (new HBox);
456         _group_tabs = new EditorGroupTabs (this);
457         h->pack_start (*_group_tabs, PACK_SHRINK);
458         h->pack_start (edit_controls_vbox);
459         controls_layout.add (*h);
460
461         ARDOUR_UI::instance()->tooltips().set_tip (*_group_tabs, _("Groups: context-click for possible operations"));
462
463         controls_layout.set_name ("EditControlsBase");
464         controls_layout.add_events (Gdk::SCROLL_MASK);
465         controls_layout.signal_scroll_event().connect (mem_fun(*this, &Editor::control_layout_scroll), false);
466
467         controls_layout.add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
468         controls_layout.signal_button_release_event().connect (mem_fun(*this, &Editor::edit_controls_button_release));
469         controls_layout_size_request_connection = controls_layout.signal_size_request().connect (mem_fun (*this, &Editor::controls_layout_size_request));
470
471         build_cursors ();
472
473         ArdourCanvas::Canvas* time_pad = manage(new ArdourCanvas::Canvas());
474         ArdourCanvas::SimpleLine* pad_line_1 = manage(new ArdourCanvas::SimpleLine(*time_pad->root(),
475                         0.0, 1.0, 100.0, 1.0));
476         pad_line_1->property_color_rgba() = 0xFF0000FF;
477         pad_line_1->show();
478         time_pad->show();
479
480         time_canvas_vbox.set_size_request (-1, (int)(timebar_height * visible_timebars) + 2);
481         time_canvas_vbox.set_size_request (-1, -1);
482
483         ruler_label_event_box.add (ruler_label_vbox);
484         ruler_label_event_box.set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
485         ruler_label_event_box.signal_button_release_event().connect (mem_fun(*this, &Editor::ruler_label_button_release));
486
487         time_button_event_box.add (time_button_vbox);
488         time_button_event_box.set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
489         time_button_event_box.signal_button_release_event().connect (mem_fun(*this, &Editor::ruler_label_button_release));
490
491         /* these enable us to have a dedicated window (for cursor setting, etc.)
492            for the canvas areas.
493         */
494
495         track_canvas_event_box.add (*track_canvas);
496
497         time_canvas_event_box.add (time_canvas_vbox);
498         time_canvas_event_box.set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
499
500         edit_packer.set_col_spacings (0);
501         edit_packer.set_row_spacings (0);
502         edit_packer.set_homogeneous (false);
503         edit_packer.set_border_width (0);
504         edit_packer.set_name ("EditorWindow");
505
506         edit_packer.attach (zoom_vbox,               0, 1, 0, 2,    SHRINK,        FILL, 0, 0);
507         /* labels for the rulers */
508         edit_packer.attach (ruler_label_event_box,   1, 2, 0, 1,    FILL,        SHRINK, 0, 0);
509         /* labels for the marker "tracks" */
510         edit_packer.attach (time_button_event_box,   1, 2, 1, 2,    FILL,        SHRINK, 0, 0);
511         /* the rulers */
512         edit_packer.attach (time_canvas_event_box,   2, 3, 0, 1,    FILL|EXPAND, FILL, 0, 0);
513         /* track controls */
514         edit_packer.attach (controls_layout,         0, 2, 2, 3,    FILL,        FILL|EXPAND, 0, 0);
515         /* main canvas */
516         edit_packer.attach (track_canvas_event_box,  2, 3, 1, 3,    FILL|EXPAND, FILL|EXPAND, 0, 0);
517
518         bottom_hbox.set_border_width (2);
519         bottom_hbox.set_spacing (3);
520
521         _route_groups = new EditorRouteGroups (this);
522         _routes = new EditorRoutes (this);
523         _regions = new EditorRegions (this);
524         _snapshots = new EditorSnapshots (this);
525         _locations = new EditorLocations (this);
526
527         Gtk::Label* nlabel;
528
529         nlabel = manage (new Label (_("Regions")));
530         nlabel->set_angle (-90);
531         the_notebook.append_page (_regions->widget (), *nlabel);
532         nlabel = manage (new Label (_("Tracks/Busses")));
533         nlabel->set_angle (-90);
534         the_notebook.append_page (_routes->widget (), *nlabel);
535         nlabel = manage (new Label (_("Snapshots")));
536         nlabel->set_angle (-90);
537         the_notebook.append_page (_snapshots->widget (), *nlabel);
538         nlabel = manage (new Label (_("Route Groups")));
539         nlabel->set_angle (-90);
540         the_notebook.append_page (_route_groups->widget (), *nlabel);
541         nlabel = manage (new Label (_("Ranges & Marks")));
542         nlabel->set_angle (-90);
543         the_notebook.append_page (_locations->widget (), *nlabel);
544
545         the_notebook.set_show_tabs (true);
546         the_notebook.set_scrollable (true);
547         the_notebook.popup_disable ();
548         the_notebook.set_tab_pos (Gtk::POS_RIGHT);
549         the_notebook.show_all ();
550         
551         post_maximal_editor_width = 0;
552         post_maximal_pane_position = 0;
553
554         VPaned *editor_summary_pane = manage(new VPaned());
555         editor_summary_pane->pack1(edit_packer);
556
557         Button* summary_arrows_left_left = manage (new Button);
558         summary_arrows_left_left->add (*manage (new Arrow (ARROW_LEFT, SHADOW_NONE)));
559         summary_arrows_left_left->signal_clicked().connect (mem_fun (*this, &Editor::horizontal_scroll_left));
560         Button* summary_arrows_left_right = manage (new Button);
561         summary_arrows_left_right->add (*manage (new Arrow (ARROW_RIGHT, SHADOW_NONE)));
562         summary_arrows_left_right->signal_clicked().connect (mem_fun (*this, &Editor::horizontal_scroll_right));
563         VBox* summary_arrows_left = manage (new VBox);
564         summary_arrows_left->pack_start (*summary_arrows_left_left);
565         summary_arrows_left->pack_start (*summary_arrows_left_right);
566
567         Button* summary_arrows_right_left = manage (new Button);
568         summary_arrows_right_left->add (*manage (new Arrow (ARROW_LEFT, SHADOW_NONE)));
569         summary_arrows_right_left->signal_clicked().connect (mem_fun (*this, &Editor::horizontal_scroll_left));
570         Button* summary_arrows_right_right = manage (new Button);
571         summary_arrows_right_right->add (*manage (new Arrow (ARROW_RIGHT, SHADOW_NONE)));
572         summary_arrows_right_right->signal_clicked().connect (mem_fun (*this, &Editor::horizontal_scroll_right));
573         VBox* summary_arrows_right = manage (new VBox);
574         summary_arrows_right->pack_start (*summary_arrows_right_left);
575         summary_arrows_right->pack_start (*summary_arrows_right_right);
576
577         Frame* summary_frame = manage (new Frame);
578         summary_frame->set_shadow_type (Gtk::SHADOW_ETCHED_IN);
579         summary_frame->add (*_summary);
580         summary_frame->show ();
581
582         HBox* summary_hbox = manage (new HBox);
583         summary_hbox->pack_start (*summary_arrows_left, false, false);
584         summary_hbox->pack_start (*summary_frame, true, true);
585         summary_hbox->pack_start (*summary_arrows_right, false, false);
586         
587         editor_summary_pane->pack2(*summary_hbox);
588
589         edit_pane.pack1 (*editor_summary_pane, true, true);
590         edit_pane.pack2 (the_notebook, false, true);
591
592         edit_pane.signal_size_allocate().connect (bind (mem_fun(*this, &Editor::pane_allocation_handler), static_cast<Paned*> (&edit_pane)));
593
594         top_hbox.pack_start (toolbar_frame, false, true);
595
596         HBox *hbox = manage (new HBox);
597         hbox->pack_start (edit_pane, true, true);
598
599         global_vpacker.pack_start (top_hbox, false, false);
600         global_vpacker.pack_start (*hbox, true, true);
601
602         global_hpacker.pack_start (global_vpacker, true, true);
603
604         set_name ("EditorWindow");
605         add_accel_group (ActionManager::ui_manager->get_accel_group());
606
607         status_bar_hpacker.show ();
608
609         vpacker.pack_end (status_bar_hpacker, false, false);
610         vpacker.pack_end (global_hpacker, true, true);
611
612         /* register actions now so that set_state() can find them and set toggles/checks etc */
613
614         register_actions ();
615
616         setup_toolbar ();
617         setup_midi_toolbar ();
618
619         _snap_type = SnapToBeat;
620         set_snap_to (_snap_type);
621         _snap_mode = SnapOff;
622         set_snap_mode (_snap_mode);
623         set_mouse_mode (MouseObject, true);
624         set_edit_point_preference (EditAtMouse, true);
625
626         XMLNode* node = ARDOUR_UI::instance()->editor_settings();
627         set_state (*node, Stateful::loading_state_version);
628
629         _playlist_selector = new PlaylistSelector();
630         _playlist_selector->signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), static_cast<Window *> (_playlist_selector)));
631
632         RegionView::RegionViewGoingAway.connect (mem_fun(*this, &Editor::catch_vanishing_regionview));
633
634         /* nudge stuff */
635
636         nudge_forward_button.add (*(manage (new Image (::get_icon("nudge_right")))));
637         nudge_backward_button.add (*(manage (new Image (::get_icon("nudge_left")))));
638
639         ARDOUR_UI::instance()->tooltips().set_tip (nudge_forward_button, _("Nudge Region/Selection Forwards"));
640         ARDOUR_UI::instance()->tooltips().set_tip (nudge_backward_button, _("Nudge Region/Selection Backwards"));
641
642         nudge_forward_button.set_name ("TransportButton");
643         nudge_backward_button.set_name ("TransportButton");
644
645         fade_context_menu.set_name ("ArdourContextMenu");
646
647         /* icons, titles, WM stuff */
648
649         list<Glib::RefPtr<Gdk::Pixbuf> > window_icons;
650         Glib::RefPtr<Gdk::Pixbuf> icon;
651
652         if ((icon = ::get_icon ("ardour_icon_16px")) != 0) {
653                 window_icons.push_back (icon);
654         }
655         if ((icon = ::get_icon ("ardour_icon_22px")) != 0) {
656                 window_icons.push_back (icon);
657         }
658         if ((icon = ::get_icon ("ardour_icon_32px")) != 0) {
659                 window_icons.push_back (icon);
660         }
661         if ((icon = ::get_icon ("ardour_icon_48px")) != 0) {
662                 window_icons.push_back (icon);
663         }
664         if (!window_icons.empty()) {
665                 set_icon_list (window_icons);
666                 set_default_icon_list (window_icons);
667         }
668
669         WindowTitle title(Glib::get_application_name());
670         title += _("Editor");
671         set_title (title.get_string());
672         set_wmclass (X_("ardour_editor"), "Ardour");
673
674         add (vpacker);
675         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
676
677         signal_configure_event().connect (mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
678         signal_delete_event().connect (mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::exit_on_main_window_close));
679
680         /* allow external control surfaces/protocols to do various things */
681
682         ControlProtocol::ZoomToSession.connect (mem_fun (*this, &Editor::temporal_zoom_session));
683         ControlProtocol::ZoomIn.connect (bind (mem_fun (*this, &Editor::temporal_zoom_step), false));
684         ControlProtocol::ZoomOut.connect (bind (mem_fun (*this, &Editor::temporal_zoom_step), true));
685         ControlProtocol::ScrollTimeline.connect (mem_fun (*this, &Editor::control_scroll));
686         BasicUI::AccessAction.connect (mem_fun (*this, &Editor::access_action));
687
688         Config->ParameterChanged.connect (mem_fun (*this, &Editor::parameter_changed));
689
690         _last_normalization_value = 0;
691
692         constructed = true;
693         instant_save ();
694 }
695
696 Editor::~Editor()
697 {
698 #ifdef WITH_CMT
699         if(image_socket_listener) {
700                 if(image_socket_listener->is_connected())
701                 {
702                         image_socket_listener->close_connection() ;
703                 }
704
705                 delete image_socket_listener ;
706                 image_socket_listener = 0 ;
707         }
708 #endif
709
710         delete _routes;
711         delete _route_groups;
712         delete track_canvas;
713         delete _drag;
714 }
715
716 void
717 Editor::add_toplevel_controls (Container& cont)
718 {
719         vpacker.pack_start (cont, false, false);
720         cont.show_all ();
721 }
722
723 void
724 Editor::catch_vanishing_regionview (RegionView *rv)
725 {
726         /* note: the selection will take care of the vanishing
727            audioregionview by itself.
728         */
729
730         if (_drag && rv->get_canvas_group() == _drag->item() && !_drag->ending()) {
731                 _drag->end_grab (0);
732                 delete _drag;
733                 _drag = 0;
734         }
735
736         if (clicked_regionview == rv) {
737                 clicked_regionview = 0;
738         }
739
740         if (entered_regionview == rv) {
741                 set_entered_regionview (0);
742         }
743 }
744
745 void
746 Editor::set_entered_regionview (RegionView* rv)
747 {
748         if (rv == entered_regionview) {
749                 return;
750         }
751
752         if (entered_regionview) {
753                 entered_regionview->exited ();
754         }
755
756         if ((entered_regionview = rv) != 0) {
757                 entered_regionview->entered ();
758         }
759 }
760
761 void
762 Editor::set_entered_track (TimeAxisView* tav)
763 {
764         if (entered_track) {
765                 entered_track->exited ();
766         }
767
768         if ((entered_track = tav) != 0) {
769                 entered_track->entered ();
770         }
771 }
772
773 void
774 Editor::show_window ()
775 {
776         if (! is_visible ()) {
777                 show_all ();
778
779                 /* re-hide editor list if necessary */
780                 editor_list_button_toggled ();
781
782                 /* re-hide summary widget if necessary */
783                 parameter_changed ("show-summary");
784
785                 parameter_changed ("show-edit-group-tabs");
786
787                 /* now reset all audio_time_axis heights, because widgets might need
788                    to be re-hidden
789                 */
790
791                 TimeAxisView *tv;
792
793                 for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
794                         tv = (static_cast<TimeAxisView*>(*i));
795                         tv->reset_height ();
796                 }
797         }
798
799         present ();
800 }
801
802 void
803 Editor::instant_save ()
804 {
805         if (!constructed || !ARDOUR_UI::instance()->session_loaded) {
806                 return;
807         }
808
809         if (session) {
810                 session->add_instant_xml(get_state());
811         } else {
812                 Config->add_instant_xml(get_state());
813         }
814 }
815
816 void
817 Editor::zoom_adjustment_changed ()
818 {
819         if (session == 0) {
820                 return;
821         }
822
823         double fpu = zoom_range_clock.current_duration() / _canvas_width;
824
825         if (fpu < 1.0) {
826                 fpu = 1.0;
827                 zoom_range_clock.set ((nframes64_t) floor (fpu * _canvas_width));
828         } else if (fpu > session->current_end_frame() / _canvas_width) {
829                 fpu = session->current_end_frame() / _canvas_width;
830                 zoom_range_clock.set ((nframes64_t) floor (fpu * _canvas_width));
831         }
832
833         temporal_zoom (fpu);
834 }
835
836 void
837 Editor::control_scroll (float fraction)
838 {
839         ENSURE_GUI_THREAD(bind (mem_fun (*this, &Editor::control_scroll), fraction));
840
841         if (!session) {
842                 return;
843         }
844
845         double step = fraction * current_page_frames();
846
847         /*
848                 _control_scroll_target is an optional<T>
849
850                 it acts like a pointer to an nframes64_t, with
851                 a operator conversion to boolean to check
852                 that it has a value could possibly use
853                 playhead_cursor->current_frame to store the
854                 value and a boolean in the class to know
855                 when it's out of date
856         */
857
858         if (!_control_scroll_target) {
859                 _control_scroll_target = session->transport_frame();
860                 _dragging_playhead = true;
861         }
862
863         if ((fraction < 0.0f) && (*_control_scroll_target < (nframes64_t) fabs(step))) {
864                 *_control_scroll_target = 0;
865         } else if ((fraction > 0.0f) && (max_frames - *_control_scroll_target < step)) {
866                 *_control_scroll_target = max_frames - (current_page_frames()*2); // allow room for slop in where the PH is on the screen
867         } else {
868                 *_control_scroll_target += (nframes64_t) floor (step);
869         }
870
871         /* move visuals, we'll catch up with it later */
872
873         playhead_cursor->set_position (*_control_scroll_target);
874         UpdateAllTransportClocks (*_control_scroll_target);
875
876         if (*_control_scroll_target > (current_page_frames() / 2)) {
877                 /* try to center PH in window */
878                 reset_x_origin (*_control_scroll_target - (current_page_frames()/2));
879         } else {
880                 reset_x_origin (0);
881         }
882
883         /*
884                 Now we do a timeout to actually bring the session to the right place
885                 according to the playhead. This is to avoid reading disk buffers on every
886                 call to control_scroll, which is driven by ScrollTimeline and therefore
887                 probably by a control surface wheel which can generate lots of events.
888         */
889         /* cancel the existing timeout */
890
891         control_scroll_connection.disconnect ();
892
893         /* add the next timeout */
894
895         control_scroll_connection = Glib::signal_timeout().connect (bind (mem_fun (*this, &Editor::deferred_control_scroll), *_control_scroll_target), 250);
896 }
897
898 bool
899 Editor::deferred_control_scroll (nframes64_t /*target*/)
900 {
901         session->request_locate (*_control_scroll_target, session->transport_rolling());
902         // reset for next stream
903         _control_scroll_target = boost::none;
904         _dragging_playhead = false;
905         return false;
906 }
907
908 void
909 Editor::access_action (std::string action_group, std::string action_item)
910 {
911         if (!session) {
912                 return;
913         }
914
915         ENSURE_GUI_THREAD (bind (mem_fun (*this, &Editor::access_action), action_group, action_item));
916
917         RefPtr<Action> act;
918         act = ActionManager::get_action( action_group.c_str(), action_item.c_str() );
919
920         if (act) {
921                 act->activate();
922         }
923
924
925 }
926
927 void
928 Editor::on_realize ()
929 {
930         Window::on_realize ();
931         Realized ();
932 }
933
934 void
935 Editor::start_scrolling ()
936 {
937         scroll_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
938                 (mem_fun(*this, &Editor::update_current_screen));
939
940 }
941
942 void
943 Editor::stop_scrolling ()
944 {
945         scroll_connection.disconnect ();
946 }
947
948 void
949 Editor::map_position_change (nframes64_t frame)
950 {
951         ENSURE_GUI_THREAD (bind (mem_fun(*this, &Editor::map_position_change), frame));
952
953         if (session == 0 || !_follow_playhead) {
954                 return;
955         }
956
957         center_screen (frame);
958         playhead_cursor->set_position (frame);
959 }
960
961 void
962 Editor::center_screen (nframes64_t frame)
963 {
964         double page = _canvas_width * frames_per_unit;
965
966         /* if we're off the page, then scroll.
967          */
968
969         if (frame < leftmost_frame || frame >= leftmost_frame + page) {
970                 center_screen_internal (frame, page);
971         }
972 }
973
974 void
975 Editor::center_screen_internal (nframes64_t frame, float page)
976 {
977         page /= 2;
978
979         if (frame > page) {
980                 frame -= (nframes64_t) page;
981         } else {
982                 frame = 0;
983         }
984
985         reset_x_origin (frame);
986 }
987
988 void
989 Editor::handle_new_duration ()
990 {
991         if (!session) {
992                 return;
993         }
994
995         ENSURE_GUI_THREAD (mem_fun (*this, &Editor::handle_new_duration));
996         nframes64_t new_end = session->current_end_frame() + (nframes64_t) floorf (current_page_frames() * 0.10f);
997
998         horizontal_adjustment.set_upper (new_end / frames_per_unit);
999         horizontal_adjustment.set_page_size (current_page_frames()/frames_per_unit);
1000
1001         if (horizontal_adjustment.get_value() + _canvas_width > horizontal_adjustment.get_upper()) {
1002                 horizontal_adjustment.set_value (horizontal_adjustment.get_upper() - _canvas_width);
1003         }
1004         //cerr << "Editor::handle_new_duration () called ha v:l:u:ps:lcf = " << horizontal_adjustment.get_value() << ":" << horizontal_adjustment.get_lower() << ":" << horizontal_adjustment.get_upper() << ":" << horizontal_adjustment.get_page_size() << ":" << endl;//DEBUG
1005 }
1006
1007 void
1008 Editor::update_title_s (const string & snap_name)
1009 {
1010         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::update_title_s), snap_name));
1011
1012         update_title ();
1013 }
1014
1015 void
1016 Editor::update_title ()
1017 {
1018         ENSURE_GUI_THREAD (mem_fun(*this, &Editor::update_title));
1019
1020         if (session) {
1021                 bool dirty = session->dirty();
1022
1023                 string session_name;
1024
1025                 if (session->snap_name() != session->name()) {
1026                         session_name = session->snap_name();
1027                 } else {
1028                         session_name = session->name();
1029                 }
1030
1031                 if (dirty) {
1032                         session_name = "*" + session_name;
1033                 }
1034
1035                 WindowTitle title(session_name);
1036                 title += Glib::get_application_name();
1037                 set_title (title.get_string());
1038         }
1039 }
1040
1041 void
1042 Editor::connect_to_session (Session *t)
1043 {
1044         session = t;
1045
1046         compute_fixed_ruler_scale ();
1047
1048         /* there are never any selected regions at startup */
1049
1050         sensitize_the_right_region_actions (false);
1051
1052         XMLNode* node = ARDOUR_UI::instance()->editor_settings();
1053         set_state (*node, Stateful::loading_state_version);
1054
1055         /* catch up with the playhead */
1056
1057         session->request_locate (playhead_cursor->current_frame);
1058
1059         update_title ();
1060
1061         session->GoingAway.connect (mem_fun(*this, &Editor::session_going_away));
1062         session->history().Changed.connect (mem_fun (*this, &Editor::history_changed));
1063
1064         /* These signals can all be emitted by a non-GUI thread. Therefore the
1065            handlers for them must not attempt to directly interact with the GUI,
1066            but use Gtkmm2ext::UI::instance()->call_slot();
1067         */
1068
1069         session_connections.push_back (session->TransportStateChange.connect (mem_fun(*this, &Editor::map_transport_state)));
1070         session_connections.push_back (session->PositionChanged.connect (mem_fun(*this, &Editor::map_position_change)));
1071         session_connections.push_back (session->RouteAdded.connect (mem_fun(*this, &Editor::handle_new_route)));
1072         session_connections.push_back (session->DurationChanged.connect (mem_fun(*this, &Editor::handle_new_duration)));
1073         session_connections.push_back (session->DirtyChanged.connect (mem_fun(*this, &Editor::update_title)));
1074         session_connections.push_back (session->StateSaved.connect (mem_fun(*this, &Editor::update_title_s)));
1075         session_connections.push_back (session->AskAboutPlaylistDeletion.connect (mem_fun(*this, &Editor::playlist_deletion_dialog)));
1076
1077         session_connections.push_back (session->TimecodeOffsetChanged.connect (mem_fun(*this, &Editor::update_just_timecode)));
1078
1079         session_connections.push_back (session->tempo_map().StateChanged.connect (mem_fun(*this, &Editor::tempo_map_changed)));
1080
1081         session_connections.push_back (session->Located.connect (mem_fun (*this, &Editor::located)));
1082         session_connections.push_back (session->config.ParameterChanged.connect (mem_fun (*this, &Editor::parameter_changed)));
1083
1084         zoom_range_clock.set_session (session);
1085         _playlist_selector->set_session (session);
1086         nudge_clock.set_session (session);
1087         if (Profile->get_sae()) {
1088                 BBT_Time bbt;
1089                 bbt.bars = 0;
1090                 bbt.beats = 0;
1091                 bbt.ticks = 120;
1092                 nframes_t pos = session->tempo_map().bbt_duration_at (0, bbt, 1);
1093                 nudge_clock.set_mode(AudioClock::BBT);
1094                 nudge_clock.set (pos, true, 0, AudioClock::BBT);
1095
1096         } else {
1097                 nudge_clock.set (session->frame_rate() * 5, true, 0, AudioClock::Timecode); // default of 5 seconds
1098         }
1099
1100         playhead_cursor->canvas_item.show ();
1101
1102         if (rhythm_ferret) {
1103                 rhythm_ferret->set_session (session);
1104         }
1105
1106         if (analysis_window != 0)
1107                 analysis_window->set_session (session);
1108
1109         Location* loc = session->locations()->auto_loop_location();
1110         if (loc == 0) {
1111                 loc = new Location (0, session->current_end_frame(), _("Loop"),(Location::Flags) (Location::IsAutoLoop | Location::IsHidden));
1112                 if (loc->start() == loc->end()) {
1113                         loc->set_end (loc->start() + 1);
1114                 }
1115                 session->locations()->add (loc, false);
1116                 session->set_auto_loop_location (loc);
1117         } else {
1118                 // force name
1119                 loc->set_name (_("Loop"));
1120         }
1121
1122         loc = session->locations()->auto_punch_location();
1123         if (loc == 0) {
1124                 loc = new Location (0, session->current_end_frame(), _("Punch"), (Location::Flags) (Location::IsAutoPunch | Location::IsHidden));
1125                 if (loc->start() == loc->end()) {
1126                         loc->set_end (loc->start() + 1);
1127                 }
1128                 session->locations()->add (loc, false);
1129                 session->set_auto_punch_location (loc);
1130         } else {
1131                 // force name
1132                 loc->set_name (_("Punch"));
1133         }
1134
1135         Config->map_parameters (mem_fun (*this, &Editor::parameter_changed));
1136         session->config.map_parameters (mem_fun (*this, &Editor::parameter_changed));
1137
1138         session->StateSaved.connect (mem_fun(*this, &Editor::session_state_saved));
1139
1140         refresh_location_display ();
1141         session->locations()->added.connect (mem_fun(*this, &Editor::add_new_location));
1142         session->locations()->removed.connect (mem_fun(*this, &Editor::location_gone));
1143         session->locations()->changed.connect (mem_fun(*this, &Editor::refresh_location_display));
1144         session->locations()->StateChanged.connect (mem_fun(*this, &Editor::refresh_location_display_s));
1145         session->locations()->end_location()->changed.connect (mem_fun(*this, &Editor::end_location_changed));
1146
1147         if (sfbrowser) {
1148                 sfbrowser->set_session (session);
1149         }
1150
1151         handle_new_duration ();
1152
1153         restore_ruler_visibility ();
1154         //tempo_map_changed (Change (0));
1155         session->tempo_map().apply_with_metrics (*this, &Editor::draw_metric_marks);
1156
1157         for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
1158                 (static_cast<TimeAxisView*>(*i))->set_samples_per_unit (frames_per_unit);
1159         }
1160
1161         start_scrolling ();
1162
1163         switch (_snap_type) {
1164         case SnapToRegionStart:
1165         case SnapToRegionEnd:
1166         case SnapToRegionSync:
1167         case SnapToRegionBoundary:
1168                 build_region_boundary_cache ();
1169                 break;
1170
1171         default:
1172                 break;
1173         }
1174
1175         /* register for undo history */
1176         session->register_with_memento_command_factory(_id, this);
1177
1178         _summary->connect_to_session (session);
1179         _group_tabs->connect_to_session (session);
1180         _route_groups->connect_to_session (session);
1181         _regions->connect_to_session (session);
1182         _snapshots->connect_to_session (session);
1183         _routes->connect_to_session (session);
1184         _locations->connect_to_session (session);
1185
1186         start_updating ();
1187 }
1188
1189 void
1190 Editor::build_cursors ()
1191 {
1192         using namespace Gdk;
1193
1194         Gdk::Color mbg ("#000000" ); /* Black */
1195         Gdk::Color mfg ("#0000ff" ); /* Blue. */
1196
1197         {
1198                 RefPtr<Bitmap> source, mask;
1199                 source = Bitmap::create (mag_bits, mag_width, mag_height);
1200                 mask = Bitmap::create (magmask_bits, mag_width, mag_height);
1201                 zoom_cursor = new Gdk::Cursor (source, mask, mfg, mbg, mag_x_hot, mag_y_hot);
1202         }
1203
1204         Gdk::Color fbg ("#ffffff" );
1205         Gdk::Color ffg  ("#000000" );
1206
1207         {
1208                 RefPtr<Bitmap> source, mask;
1209
1210                 source = Bitmap::create (fader_cursor_bits, fader_cursor_width, fader_cursor_height);
1211                 mask = Bitmap::create (fader_cursor_mask_bits, fader_cursor_width, fader_cursor_height);
1212                 fader_cursor = new Gdk::Cursor (source, mask, ffg, fbg, fader_cursor_x_hot, fader_cursor_y_hot);
1213         }
1214
1215         {
1216                 RefPtr<Bitmap> source, mask;
1217                 source = Bitmap::create (speaker_cursor_bits, speaker_cursor_width, speaker_cursor_height);
1218                 mask = Bitmap::create (speaker_cursor_mask_bits, speaker_cursor_width, speaker_cursor_height);
1219                 speaker_cursor = new Gdk::Cursor (source, mask, ffg, fbg, speaker_cursor_x_hot, speaker_cursor_y_hot);
1220         }
1221
1222         {
1223                 RefPtr<Bitmap> bits;
1224                 char pix[4] = { 0, 0, 0, 0 };
1225                 bits = Bitmap::create (pix, 2, 2);
1226                 Gdk::Color c;
1227                 transparent_cursor = new Gdk::Cursor (bits, bits, c, c, 0, 0);
1228         }
1229
1230         {
1231                 RefPtr<Bitmap> bits;
1232                 char pix[4] = { 0, 0, 0, 0 };
1233                 bits = Bitmap::create (pix, 2, 2);
1234                 Gdk::Color c;
1235                 transparent_cursor = new Gdk::Cursor (bits, bits, c, c, 0, 0);
1236         }
1237
1238
1239         grabber_cursor = new Gdk::Cursor (HAND2);
1240
1241         {
1242                 Glib::RefPtr<Gdk::Pixbuf> grabber_edit_point_pixbuf (::get_icon ("grabber_edit_point"));
1243                 grabber_edit_point_cursor = new Gdk::Cursor (Gdk::Display::get_default(), grabber_edit_point_pixbuf, 5, 17);
1244         }
1245
1246         cross_hair_cursor = new Gdk::Cursor (CROSSHAIR);
1247         trimmer_cursor =  new Gdk::Cursor (SB_H_DOUBLE_ARROW);
1248         selector_cursor = new Gdk::Cursor (XTERM);
1249         time_fx_cursor = new Gdk::Cursor (SIZING);
1250         wait_cursor = new Gdk::Cursor  (WATCH);
1251         timebar_cursor = new Gdk::Cursor(LEFT_PTR);
1252         midi_pencil_cursor = new Gdk::Cursor (PENCIL);
1253         midi_select_cursor = new Gdk::Cursor (CENTER_PTR);
1254         midi_resize_cursor = new Gdk::Cursor (SIZING);
1255         midi_erase_cursor = new Gdk::Cursor (DRAPED_BOX);
1256 }
1257
1258 /** Pop up a context menu for when the user clicks on a fade in or fade out */
1259 void
1260 Editor::popup_fade_context_menu (int button, int32_t time, ArdourCanvas::Item* item, ItemType item_type)
1261 {
1262         using namespace Menu_Helpers;
1263         AudioRegionView* arv = static_cast<AudioRegionView*> (item->get_data ("regionview"));
1264
1265         if (arv == 0) {
1266                 fatal << _("programming error: fade in canvas item has no regionview data pointer!") << endmsg;
1267                 /*NOTREACHED*/
1268         }
1269
1270         MenuList& items (fade_context_menu.items());
1271
1272         items.clear ();
1273
1274         switch (item_type) {
1275         case FadeInItem:
1276         case FadeInHandleItem:
1277                 if (arv->audio_region()->fade_in_active()) {
1278                         items.push_back (MenuElem (_("Deactivate"), bind (mem_fun (*this, &Editor::set_fade_in_active), false)));
1279                 } else {
1280                         items.push_back (MenuElem (_("Activate"), bind (mem_fun (*this, &Editor::set_fade_in_active), true)));
1281                 }
1282
1283                 items.push_back (SeparatorElem());
1284
1285                 if (Profile->get_sae()) {
1286                         items.push_back (MenuElem (_("Linear"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::Linear)));
1287                         items.push_back (MenuElem (_("Slowest"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::Fast)));
1288                 } else {
1289                         items.push_back (MenuElem (_("Linear"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::Linear)));
1290                         items.push_back (MenuElem (_("Slowest"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::Fast)));
1291                         items.push_back (MenuElem (_("Slow"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::LogB)));
1292                         items.push_back (MenuElem (_("Fast"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::LogA)));
1293                         items.push_back (MenuElem (_("Fastest"), bind (mem_fun (*this, &Editor::set_fade_in_shape), AudioRegion::Slow)));
1294                 }
1295
1296                 break;
1297
1298         case FadeOutItem:
1299         case FadeOutHandleItem:
1300                 if (arv->audio_region()->fade_out_active()) {
1301                         items.push_back (MenuElem (_("Deactivate"), bind (mem_fun (*this, &Editor::set_fade_out_active), false)));
1302                 } else {
1303                         items.push_back (MenuElem (_("Activate"), bind (mem_fun (*this, &Editor::set_fade_out_active), true)));
1304                 }
1305
1306                 items.push_back (SeparatorElem());
1307
1308                 if (Profile->get_sae()) {
1309                         items.push_back (MenuElem (_("Linear"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::Linear)));
1310                         items.push_back (MenuElem (_("Slowest"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::Slow)));
1311                 } else {
1312                         items.push_back (MenuElem (_("Linear"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::Linear)));
1313                         items.push_back (MenuElem (_("Slowest"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::Slow)));
1314                         items.push_back (MenuElem (_("Slow"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::LogA)));
1315                         items.push_back (MenuElem (_("Fast"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::LogB)));
1316                         items.push_back (MenuElem (_("Fastest"), bind (mem_fun (*this, &Editor::set_fade_out_shape), AudioRegion::Fast)));
1317                 }
1318
1319                 break;
1320
1321         default:
1322                 fatal << _("programming error: ")
1323                       << X_("non-fade canvas item passed to popup_fade_context_menu()")
1324                       << endmsg;
1325                 /*NOTREACHED*/
1326         }
1327
1328         fade_context_menu.popup (button, time);
1329 }
1330
1331 void
1332 Editor::popup_track_context_menu (int button, int32_t time, ItemType item_type, bool with_selection, nframes64_t frame)
1333 {
1334         using namespace Menu_Helpers;
1335         Menu* (Editor::*build_menu_function)(nframes64_t);
1336         Menu *menu;
1337
1338         switch (item_type) {
1339         case RegionItem:
1340         case RegionViewName:
1341         case RegionViewNameHighlight:
1342                 if (with_selection) {
1343                         build_menu_function = &Editor::build_track_selection_context_menu;
1344                 } else {
1345                         build_menu_function = &Editor::build_track_region_context_menu;
1346                 }
1347                 break;
1348
1349         case SelectionItem:
1350                 if (with_selection) {
1351                         build_menu_function = &Editor::build_track_selection_context_menu;
1352                 } else {
1353                         build_menu_function = &Editor::build_track_context_menu;
1354                 }
1355                 break;
1356
1357         case CrossfadeViewItem:
1358                 build_menu_function = &Editor::build_track_crossfade_context_menu;
1359                 break;
1360
1361         case StreamItem:
1362                 if (clicked_routeview->get_diskstream()) {
1363                         build_menu_function = &Editor::build_track_context_menu;
1364                 } else {
1365                         build_menu_function = &Editor::build_track_bus_context_menu;
1366                 }
1367                 break;
1368
1369         default:
1370                 /* probably shouldn't happen but if it does, we don't care */
1371                 return;
1372         }
1373
1374         menu = (this->*build_menu_function)(frame);
1375         menu->set_name ("ArdourContextMenu");
1376
1377         /* now handle specific situations */
1378
1379         switch (item_type) {
1380         case RegionItem:
1381         case RegionViewName:
1382         case RegionViewNameHighlight:
1383                 if (!with_selection) {
1384                         if (region_edit_menu_split_item) {
1385                                 if (clicked_regionview && clicked_regionview->region()->covers (get_preferred_edit_position())) {
1386                                         ActionManager::set_sensitive (ActionManager::edit_point_in_region_sensitive_actions, true);
1387                                 } else {
1388                                         ActionManager::set_sensitive (ActionManager::edit_point_in_region_sensitive_actions, false);
1389                                 }
1390                         }
1391                         /*
1392                         if (region_edit_menu_split_multichannel_item) {
1393                                 if (clicked_regionview && clicked_regionview->region().n_channels() > 1) {
1394                                         // GTK2FIX find the action, change its sensitivity
1395                                         // region_edit_menu_split_multichannel_item->set_sensitive (true);
1396                                 } else {
1397                                         // GTK2FIX see above
1398                                         // region_edit_menu_split_multichannel_item->set_sensitive (false);
1399                                 }
1400                         }*/
1401                 }
1402                 break;
1403
1404         case SelectionItem:
1405                 break;
1406
1407         case CrossfadeViewItem:
1408                 break;
1409
1410         case StreamItem:
1411                 break;
1412
1413         default:
1414                 /* probably shouldn't happen but if it does, we don't care */
1415                 return;
1416         }
1417
1418         if (item_type != SelectionItem && clicked_routeview && clicked_routeview->audio_track()) {
1419
1420                 /* Bounce to disk */
1421
1422                 using namespace Menu_Helpers;
1423                 MenuList& edit_items  = menu->items();
1424
1425                 edit_items.push_back (SeparatorElem());
1426
1427                 switch (clicked_routeview->audio_track()->freeze_state()) {
1428                 case AudioTrack::NoFreeze:
1429                         edit_items.push_back (MenuElem (_("Freeze"), mem_fun(*this, &Editor::freeze_route)));
1430                         break;
1431
1432                 case AudioTrack::Frozen:
1433                         edit_items.push_back (MenuElem (_("Unfreeze"), mem_fun(*this, &Editor::unfreeze_route)));
1434                         break;
1435
1436                 case AudioTrack::UnFrozen:
1437                         edit_items.push_back (MenuElem (_("Freeze"), mem_fun(*this, &Editor::freeze_route)));
1438                         break;
1439                 }
1440
1441         }
1442
1443         if (item_type == StreamItem && clicked_routeview) {
1444                 clicked_routeview->build_underlay_menu(menu);
1445         }
1446
1447         menu->popup (button, time);
1448 }
1449
1450 Menu*
1451 Editor::build_track_context_menu (nframes64_t)
1452 {
1453         using namespace Menu_Helpers;
1454
1455         MenuList& edit_items = track_context_menu.items();
1456         edit_items.clear();
1457
1458         add_dstream_context_items (edit_items);
1459         return &track_context_menu;
1460 }
1461
1462 Menu*
1463 Editor::build_track_bus_context_menu (nframes64_t)
1464 {
1465         using namespace Menu_Helpers;
1466
1467         MenuList& edit_items = track_context_menu.items();
1468         edit_items.clear();
1469
1470         add_bus_context_items (edit_items);
1471         return &track_context_menu;
1472 }
1473
1474 Menu*
1475 Editor::build_track_region_context_menu (nframes64_t frame)
1476 {
1477         using namespace Menu_Helpers;
1478         MenuList& edit_items  = track_region_context_menu.items();
1479         edit_items.clear();
1480
1481         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (clicked_axisview);
1482
1483         if (rtv) {
1484                 boost::shared_ptr<Diskstream> ds;
1485                 boost::shared_ptr<Playlist> pl;
1486
1487                 if ((ds = rtv->get_diskstream()) && ((pl = ds->playlist()))) {
1488                         Playlist::RegionList* regions = pl->regions_at ((nframes64_t) floor ( (double)frame * ds->speed()));
1489
1490                         if (selection->regions.size() > 1) {
1491                                 // there's already a multiple selection: just add a
1492                                 // single region context menu that will act on all
1493                                 // selected regions
1494                                 boost::shared_ptr<Region> dummy_region; // = NULL
1495                                 add_region_context_items (rtv->view(), dummy_region, edit_items);
1496                         } else {
1497                                 for (Playlist::RegionList::iterator i = regions->begin(); i != regions->end(); ++i) {
1498                                         add_region_context_items (rtv->view(), (*i), edit_items);
1499                                 }
1500                         }
1501
1502                         delete regions;
1503                 }
1504         }
1505
1506         add_dstream_context_items (edit_items);
1507
1508         return &track_region_context_menu;
1509 }
1510
1511 Menu*
1512 Editor::build_track_crossfade_context_menu (nframes64_t frame)
1513 {
1514         using namespace Menu_Helpers;
1515         MenuList& edit_items  = track_crossfade_context_menu.items();
1516         edit_items.clear ();
1517
1518         AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*> (clicked_axisview);
1519
1520         if (atv) {
1521                 boost::shared_ptr<Diskstream> ds;
1522                 boost::shared_ptr<Playlist> pl;
1523                 boost::shared_ptr<AudioPlaylist> apl;
1524
1525                 if ((ds = atv->get_diskstream()) && ((pl = ds->playlist()) != 0) && ((apl = boost::dynamic_pointer_cast<AudioPlaylist> (pl)) != 0)) {
1526
1527                         Playlist::RegionList* regions = pl->regions_at (frame);
1528                         AudioPlaylist::Crossfades xfades;
1529
1530                         apl->crossfades_at (frame, xfades);
1531
1532                         bool many = xfades.size() > 1;
1533
1534                         for (AudioPlaylist::Crossfades::iterator i = xfades.begin(); i != xfades.end(); ++i) {
1535                                 add_crossfade_context_items (atv->audio_view(), (*i), edit_items, many);
1536                         }
1537
1538                         if (selection->regions.size() > 1) {
1539                                 // there's already a multiple selection: just add a
1540                                 // single region context menu that will act on all
1541                                 // selected regions
1542                                 boost::shared_ptr<Region> dummy_region; // = NULL
1543                                 add_region_context_items (atv->audio_view(), dummy_region, edit_items);
1544                         } else {
1545                                 for (Playlist::RegionList::iterator i = regions->begin(); i != regions->end(); ++i) {
1546                                         add_region_context_items (atv->audio_view(), (*i), edit_items);
1547                                 }
1548                         }
1549                         delete regions;
1550                 }
1551         }
1552
1553         add_dstream_context_items (edit_items);
1554
1555         return &track_crossfade_context_menu;
1556 }
1557
1558 void
1559 Editor::analyze_region_selection()
1560 {
1561         if (analysis_window == 0) {
1562                 analysis_window = new AnalysisWindow();
1563
1564                 if (session != 0)
1565                         analysis_window->set_session(session);
1566
1567                 analysis_window->show_all();
1568         }
1569
1570         analysis_window->set_regionmode();
1571         analysis_window->analyze();
1572
1573         analysis_window->present();
1574 }
1575
1576 void
1577 Editor::analyze_range_selection()
1578 {
1579         if (analysis_window == 0) {
1580                 analysis_window = new AnalysisWindow();
1581
1582                 if (session != 0)
1583                         analysis_window->set_session(session);
1584
1585                 analysis_window->show_all();
1586         }
1587
1588         analysis_window->set_rangemode();
1589         analysis_window->analyze();
1590
1591         analysis_window->present();
1592 }
1593
1594 Menu*
1595 Editor::build_track_selection_context_menu (nframes64_t)
1596 {
1597         using namespace Menu_Helpers;
1598         MenuList& edit_items  = track_selection_context_menu.items();
1599         edit_items.clear ();
1600
1601         add_selection_context_items (edit_items);
1602         // edit_items.push_back (SeparatorElem());
1603         // add_dstream_context_items (edit_items);
1604
1605         return &track_selection_context_menu;
1606 }
1607
1608 /** Add context menu items relevant to crossfades.
1609  * @param edit_items List to add the items to.
1610  */
1611 void
1612 Editor::add_crossfade_context_items (AudioStreamView* /*view*/, boost::shared_ptr<Crossfade> xfade, Menu_Helpers::MenuList& edit_items, bool many)
1613 {
1614         using namespace Menu_Helpers;
1615         Menu     *xfade_menu = manage (new Menu);
1616         MenuList& items       = xfade_menu->items();
1617         xfade_menu->set_name ("ArdourContextMenu");
1618         string str;
1619
1620         if (xfade->active()) {
1621                 str = _("Mute");
1622         } else {
1623                 str = _("Unmute");
1624         }
1625
1626         items.push_back (MenuElem (str, bind (mem_fun(*this, &Editor::toggle_xfade_active), boost::weak_ptr<Crossfade> (xfade))));
1627         items.push_back (MenuElem (_("Edit"), bind (mem_fun(*this, &Editor::edit_xfade), boost::weak_ptr<Crossfade> (xfade))));
1628
1629         if (xfade->can_follow_overlap()) {
1630
1631                 if (xfade->following_overlap()) {
1632                         str = _("Convert to short");
1633                 } else {
1634                         str = _("Convert to full");
1635                 }
1636
1637                 items.push_back (MenuElem (str, bind (mem_fun(*this, &Editor::toggle_xfade_length), xfade)));
1638         }
1639
1640         if (many) {
1641                 str = xfade->out()->name();
1642                 str += "->";
1643                 str += xfade->in()->name();
1644         } else {
1645                 str = _("Crossfade");
1646         }
1647
1648         edit_items.push_back (MenuElem (str, *xfade_menu));
1649         edit_items.push_back (SeparatorElem());
1650 }
1651
1652 void
1653 Editor::xfade_edit_left_region ()
1654 {
1655         if (clicked_crossfadeview) {
1656                 clicked_crossfadeview->left_view.show_region_editor ();
1657         }
1658 }
1659
1660 void
1661 Editor::xfade_edit_right_region ()
1662 {
1663         if (clicked_crossfadeview) {
1664                 clicked_crossfadeview->right_view.show_region_editor ();
1665         }
1666 }
1667
1668 void
1669 Editor::add_region_context_items (StreamView* sv, boost::shared_ptr<Region> region, Menu_Helpers::MenuList& edit_items)
1670 {
1671         using namespace Menu_Helpers;
1672         Gtk::MenuItem* foo_item;
1673         Menu     *region_menu = manage (new Menu);
1674         MenuList& items       = region_menu->items();
1675         region_menu->set_name ("ArdourContextMenu");
1676
1677         boost::shared_ptr<AudioRegion> ar;
1678         boost::shared_ptr<MidiRegion>  mr;
1679
1680         if (region) {
1681                 ar = boost::dynamic_pointer_cast<AudioRegion> (region);
1682                 mr = boost::dynamic_pointer_cast<MidiRegion> (region);
1683
1684                 /* when this particular menu pops up, make the relevant region
1685                    become selected.
1686                 */
1687
1688                 region_menu->signal_map_event().connect (
1689                         bind (mem_fun(*this, &Editor::set_selected_regionview_from_map_event), sv, boost::weak_ptr<Region>(region)));
1690
1691                 items.push_back (MenuElem (_("Rename"), mem_fun(*this, &Editor::rename_region)));
1692                 if (mr && internal_editing()) {
1693                         items.push_back (MenuElem (_("List editor..."), mem_fun(*this, &Editor::show_midi_list_editor)));
1694                 } else {
1695                         items.push_back (MenuElem (_("Region editor"), mem_fun(*this, &Editor::edit_region)));
1696                 }
1697         }
1698
1699         items.push_back (MenuElem (_("Raise to top layer"), mem_fun(*this, &Editor::raise_region_to_top)));
1700         items.push_back (MenuElem (_("Lower to bottom layer"), mem_fun  (*this, &Editor::lower_region_to_bottom)));
1701         items.push_back (SeparatorElem());
1702         items.push_back (MenuElem (_("Define sync point"), mem_fun(*this, &Editor::set_region_sync_from_edit_point)));
1703         if (_edit_point == EditAtMouse) {
1704                 items.back ().set_sensitive (false);
1705         }
1706         items.push_back (MenuElem (_("Remove sync point"), mem_fun(*this, &Editor::remove_region_sync)));
1707         items.push_back (SeparatorElem());
1708
1709         items.push_back (MenuElem (_("Audition"), mem_fun(*this, &Editor::play_selected_region)));
1710         items.push_back (MenuElem (_("Export"), mem_fun(*this, &Editor::export_region)));
1711         items.push_back (MenuElem (_("Bounce"), mem_fun(*this, &Editor::bounce_region_selection)));
1712
1713         if (ar) {
1714                 items.push_back (MenuElem (_("Spectral Analysis"), mem_fun(*this, &Editor::analyze_region_selection)));
1715         }
1716
1717         items.push_back (SeparatorElem());
1718
1719         sigc::connection fooc;
1720         boost::shared_ptr<Region> region_to_check;
1721
1722         if (region) {
1723                 region_to_check = region;
1724         } else {
1725                 region_to_check = selection->regions.front()->region();
1726         }
1727
1728         items.push_back (CheckMenuElem (_("Lock")));
1729         CheckMenuItem* region_lock_item = static_cast<CheckMenuItem*>(&items.back());
1730         if (region_to_check->locked()) {
1731                 region_lock_item->set_active();
1732         }
1733         region_lock_item->signal_activate().connect (mem_fun(*this, &Editor::toggle_region_lock));
1734
1735         items.push_back (CheckMenuElem (_("Glue to Bars&Beats")));
1736         CheckMenuItem* bbt_glue_item = static_cast<CheckMenuItem*>(&items.back());
1737
1738         switch (region_to_check->positional_lock_style()) {
1739         case Region::MusicTime:
1740                 bbt_glue_item->set_active (true);
1741                 break;
1742         default:
1743                 bbt_glue_item->set_active (false);
1744                 break;
1745         }
1746
1747         bbt_glue_item->signal_activate().connect (bind (mem_fun (*this, &Editor::set_region_lock_style), Region::MusicTime));
1748
1749         items.push_back (CheckMenuElem (_("Mute")));
1750         CheckMenuItem* region_mute_item = static_cast<CheckMenuItem*>(&items.back());
1751         fooc = region_mute_item->signal_activate().connect (mem_fun(*this, &Editor::toggle_region_mute));
1752         if (region_to_check->muted()) {
1753                 fooc.block (true);
1754                 region_mute_item->set_active();
1755                 fooc.block (false);
1756         }
1757
1758         if (!Profile->get_sae()) {
1759                 items.push_back (CheckMenuElem (_("Opaque")));
1760                 CheckMenuItem* region_opaque_item = static_cast<CheckMenuItem*>(&items.back());
1761                 fooc = region_opaque_item->signal_activate().connect (mem_fun(*this, &Editor::toggle_region_opaque));
1762                 if (region_to_check->opaque()) {
1763                         fooc.block (true);
1764                         region_opaque_item->set_active();
1765                         fooc.block (false);
1766                 }
1767         }
1768
1769         items.push_back (CheckMenuElem (_("Original position"), mem_fun(*this, &Editor::naturalize)));
1770         if (region_to_check->at_natural_position()) {
1771                 items.back().set_sensitive (false);
1772         }
1773
1774         items.push_back (SeparatorElem());
1775
1776         if (ar) {
1777
1778                 RegionView* rv = sv->find_view (ar);
1779                 AudioRegionView* arv = dynamic_cast<AudioRegionView*>(rv);
1780
1781                 if (!Profile->get_sae()) {
1782                         items.push_back (MenuElem (_("Reset Envelope"), mem_fun(*this, &Editor::reset_region_gain_envelopes)));
1783
1784                         items.push_back (CheckMenuElem (_("Envelope Visible")));
1785                         CheckMenuItem* region_envelope_visible_item = static_cast<CheckMenuItem*> (&items.back());
1786                         fooc = region_envelope_visible_item->signal_activate().connect (mem_fun(*this, &Editor::toggle_gain_envelope_visibility));
1787                         if (arv->envelope_visible()) {
1788                                 fooc.block (true);
1789                                 region_envelope_visible_item->set_active (true);
1790                                 fooc.block (false);
1791                         }
1792
1793                         items.push_back (CheckMenuElem (_("Envelope Active")));
1794                         CheckMenuItem* region_envelope_active_item = static_cast<CheckMenuItem*> (&items.back());
1795                         fooc = region_envelope_active_item->signal_activate().connect (mem_fun(*this, &Editor::toggle_gain_envelope_active));
1796
1797                         if (ar->envelope_active()) {
1798                                 fooc.block (true);
1799                                 region_envelope_active_item->set_active (true);
1800                                 fooc.block (false);
1801                         }
1802
1803                         items.push_back (SeparatorElem());
1804                 }
1805
1806                 items.push_back (MenuElem (_("Normalize"), mem_fun(*this, &Editor::normalize_region)));
1807                 if (ar->scale_amplitude() != 1) {
1808                         items.push_back (MenuElem (_("Reset Gain"), mem_fun(*this, &Editor::reset_region_scale_amplitude)));
1809                 }
1810
1811         } else if (mr) {
1812                 items.push_back (MenuElem (_("Quantize"), mem_fun(*this, &Editor::quantize_region)));
1813                 items.push_back (SeparatorElem());
1814         }
1815
1816         items.push_back (MenuElem (_("Strip Silence..."), mem_fun (*this, &Editor::strip_region_silence)));
1817         items.push_back (MenuElem (_("Reverse"), mem_fun(*this, &Editor::reverse_region)));
1818         items.push_back (SeparatorElem());
1819
1820         /* range related stuff */
1821
1822         items.push_back (MenuElem (_("Add Single Range"), mem_fun (*this, &Editor::add_location_from_audio_region)));
1823         items.push_back (MenuElem (_("Add Range Markers"), mem_fun (*this, &Editor::add_locations_from_audio_region)));
1824         if (selection->regions.size() < 2) {
1825                 items.back().set_sensitive (false);
1826         }
1827
1828         items.push_back (MenuElem (_("Set Range Selection"), mem_fun (*this, &Editor::set_selection_from_region)));
1829         items.push_back (SeparatorElem());
1830
1831         /* Nudge region */
1832
1833         Menu *nudge_menu = manage (new Menu());
1834         MenuList& nudge_items = nudge_menu->items();
1835         nudge_menu->set_name ("ArdourContextMenu");
1836
1837         nudge_items.push_back (MenuElem (_("Nudge fwd"), (bind (mem_fun(*this, &Editor::nudge_forward), false, false))));
1838         nudge_items.push_back (MenuElem (_("Nudge bwd"), (bind (mem_fun(*this, &Editor::nudge_backward), false, false))));
1839         nudge_items.push_back (MenuElem (_("Nudge fwd by capture offset"), (mem_fun(*this, &Editor::nudge_forward_capture_offset))));
1840         nudge_items.push_back (MenuElem (_("Nudge bwd by capture offset"), (mem_fun(*this, &Editor::nudge_backward_capture_offset))));
1841
1842         items.push_back (MenuElem (_("Nudge"), *nudge_menu));
1843         items.push_back (SeparatorElem());
1844
1845         Menu *trim_menu = manage (new Menu);
1846         MenuList& trim_items = trim_menu->items();
1847         trim_menu->set_name ("ArdourContextMenu");
1848
1849         trim_items.push_back (MenuElem (_("Start to edit point"), mem_fun(*this, &Editor::trim_region_from_edit_point)));
1850         foo_item = &trim_items.back();
1851         if (_edit_point == EditAtMouse) {
1852                 foo_item->set_sensitive (false);
1853         }
1854         trim_items.push_back (MenuElem (_("Edit point to end"), mem_fun(*this, &Editor::trim_region_to_edit_point)));
1855         foo_item = &trim_items.back();
1856         if (_edit_point == EditAtMouse) {
1857                 foo_item->set_sensitive (false);
1858         }
1859         trim_items.push_back (MenuElem (_("Trim To Loop"), mem_fun(*this, &Editor::trim_region_to_loop)));
1860         trim_items.push_back (MenuElem (_("Trim To Punch"), mem_fun(*this, &Editor::trim_region_to_punch)));
1861
1862         items.push_back (MenuElem (_("Trim"), *trim_menu));
1863         items.push_back (SeparatorElem());
1864
1865         items.push_back (MenuElem (_("Split"), (mem_fun(*this, &Editor::split))));
1866         region_edit_menu_split_item = &items.back();
1867
1868         if (_edit_point == EditAtMouse) {
1869                 region_edit_menu_split_item->set_sensitive (false);
1870         }
1871
1872         items.push_back (MenuElem (_("Make mono regions"), (mem_fun(*this, &Editor::split_multichannel_region))));
1873         region_edit_menu_split_multichannel_item = &items.back();
1874
1875         items.push_back (MenuElem (_("Duplicate"), (bind (mem_fun(*this, &Editor::duplicate_dialog), false))));
1876         items.push_back (MenuElem (_("Multi-Duplicate"), (bind (mem_fun(*this, &Editor::duplicate_dialog), true))));
1877         items.push_back (MenuElem (_("Fill Track"), (mem_fun(*this, &Editor::region_fill_track))));
1878         items.push_back (SeparatorElem());
1879         items.push_back (MenuElem (_("Remove"), mem_fun(*this, &Editor::remove_selected_regions)));
1880
1881         /* OK, stick the region submenu at the top of the list, and then add
1882            the standard items.
1883         */
1884
1885         /* we have to hack up the region name because "_" has a special
1886            meaning for menu titles.
1887         */
1888
1889         string::size_type pos = 0;
1890         string menu_item_name = (region) ? region->name() : _("Selected regions");
1891
1892         while ((pos = menu_item_name.find ("_", pos)) != string::npos) {
1893                 menu_item_name.replace (pos, 1, "__");
1894                 pos += 2;
1895         }
1896
1897         edit_items.push_back (MenuElem (menu_item_name, *region_menu));
1898         edit_items.push_back (SeparatorElem());
1899 }
1900
1901 /** Add context menu items relevant to selection ranges.
1902  * @param edit_items List to add the items to.
1903  */
1904 void
1905 Editor::add_selection_context_items (Menu_Helpers::MenuList& edit_items)
1906 {
1907         using namespace Menu_Helpers;
1908
1909         edit_items.push_back (MenuElem (_("Play Range"), mem_fun(*this, &Editor::play_selection)));
1910         edit_items.push_back (MenuElem (_("Loop Range"), bind (mem_fun(*this, &Editor::set_loop_from_selection), true)));
1911
1912         edit_items.push_back (SeparatorElem());
1913         edit_items.push_back (MenuElem (_("Spectral Analysis"), mem_fun(*this, &Editor::analyze_range_selection)));
1914
1915         if (!selection->regions.empty()) {
1916                 edit_items.push_back (SeparatorElem());
1917                 edit_items.push_back (MenuElem (_("Extend Range to End of Region"), bind (mem_fun(*this, &Editor::extend_selection_to_end_of_region), false)));
1918                 edit_items.push_back (MenuElem (_("Extend Range to Start of Region"), bind (mem_fun(*this, &Editor::extend_selection_to_start_of_region), false)));
1919         }
1920
1921         edit_items.push_back (SeparatorElem());
1922         edit_items.push_back (MenuElem (_("Silence Range"), mem_fun(*this, &Editor::separate_region_from_selection)));
1923         edit_items.push_back (MenuElem (_("Convert to Region in Region List"), mem_fun(*this, &Editor::new_region_from_selection)));
1924
1925         edit_items.push_back (SeparatorElem());
1926         edit_items.push_back (MenuElem (_("Select All in Range"), mem_fun(*this, &Editor::select_all_selectables_using_time_selection)));
1927
1928         edit_items.push_back (SeparatorElem());
1929         edit_items.push_back (MenuElem (_("Set Loop from Range"), bind (mem_fun(*this, &Editor::set_loop_from_selection), false)));
1930         edit_items.push_back (MenuElem (_("Set Punch from Range"), mem_fun(*this, &Editor::set_punch_from_selection)));
1931
1932         edit_items.push_back (SeparatorElem());
1933         edit_items.push_back (MenuElem (_("Add Range Markers"), mem_fun (*this, &Editor::add_location_from_selection)));
1934
1935         edit_items.push_back (SeparatorElem());
1936         edit_items.push_back (MenuElem (_("Crop Region to Range"), mem_fun(*this, &Editor::crop_region_to_selection)));
1937         edit_items.push_back (MenuElem (_("Fill Range with Region"), mem_fun(*this, &Editor::region_fill_selection)));
1938         edit_items.push_back (MenuElem (_("Duplicate Range"), bind (mem_fun(*this, &Editor::duplicate_dialog), false)));
1939
1940         edit_items.push_back (SeparatorElem());
1941         edit_items.push_back (MenuElem (_("Consolidate Range"), bind (mem_fun(*this, &Editor::bounce_range_selection), true, false)));
1942         edit_items.push_back (MenuElem (_("Consolidate Range With Processing"), bind (mem_fun(*this, &Editor::bounce_range_selection), true, true)));
1943         edit_items.push_back (MenuElem (_("Bounce Range to Region List"), bind (mem_fun(*this, &Editor::bounce_range_selection), false, false)));
1944         edit_items.push_back (MenuElem (_("Bounce Range to Region List With Processing"), bind (mem_fun(*this, &Editor::bounce_range_selection), false, true)));
1945         edit_items.push_back (MenuElem (_("Export Range"), mem_fun(*this, &Editor::export_range)));
1946 }
1947
1948
1949 void
1950 Editor::add_dstream_context_items (Menu_Helpers::MenuList& edit_items)
1951 {
1952         using namespace Menu_Helpers;
1953
1954         /* Playback */
1955
1956         Menu *play_menu = manage (new Menu);
1957         MenuList& play_items = play_menu->items();
1958         play_menu->set_name ("ArdourContextMenu");
1959
1960         play_items.push_back (MenuElem (_("Play from edit point"), mem_fun(*this, &Editor::play_from_edit_point)));
1961         play_items.push_back (MenuElem (_("Play from start"), mem_fun(*this, &Editor::play_from_start)));
1962         play_items.push_back (MenuElem (_("Play region"), mem_fun(*this, &Editor::play_selected_region)));
1963         play_items.push_back (SeparatorElem());
1964         play_items.push_back (MenuElem (_("Loop Region"), mem_fun(*this, &Editor::loop_selected_region)));
1965
1966         edit_items.push_back (MenuElem (_("Play"), *play_menu));
1967
1968         /* Selection */
1969
1970         Menu *select_menu = manage (new Menu);
1971         MenuList& select_items = select_menu->items();
1972         select_menu->set_name ("ArdourContextMenu");
1973
1974         select_items.push_back (MenuElem (_("Select All in track"), bind (mem_fun(*this, &Editor::select_all_in_track), Selection::Set)));
1975         select_items.push_back (MenuElem (_("Select All"), bind (mem_fun(*this, &Editor::select_all), Selection::Set)));
1976         select_items.push_back (MenuElem (_("Invert selection in track"), mem_fun(*this, &Editor::invert_selection_in_track)));
1977         select_items.push_back (MenuElem (_("Invert selection"), mem_fun(*this, &Editor::invert_selection)));
1978         select_items.push_back (SeparatorElem());
1979         select_items.push_back (MenuElem (_("Set range to loop range"), mem_fun(*this, &Editor::set_selection_from_loop)));
1980         select_items.push_back (MenuElem (_("Set range to punch range"), mem_fun(*this, &Editor::set_selection_from_punch)));
1981         select_items.push_back (SeparatorElem());
1982         select_items.push_back (MenuElem (_("Select All After Edit Point"), bind (mem_fun(*this, &Editor::select_all_selectables_using_edit), true)));
1983         select_items.push_back (MenuElem (_("Select All Before Edit Point"), bind (mem_fun(*this, &Editor::select_all_selectables_using_edit), false)));
1984         select_items.push_back (MenuElem (_("Select All After Playhead"), bind (mem_fun(*this, &Editor::select_all_selectables_using_cursor), playhead_cursor, true)));
1985         select_items.push_back (MenuElem (_("Select All Before Playhead"), bind (mem_fun(*this, &Editor::select_all_selectables_using_cursor), playhead_cursor, false)));
1986         select_items.push_back (MenuElem (_("Select All Between Playhead & Edit Point"), bind (mem_fun(*this, &Editor::select_all_selectables_between), false)));
1987         select_items.push_back (MenuElem (_("Select All Within Playhead & Edit Point"), bind (mem_fun(*this, &Editor::select_all_selectables_between), true)));
1988         select_items.push_back (MenuElem (_("Select Range Between Playhead & Edit Point"), mem_fun(*this, &Editor::select_range_between)));
1989
1990         edit_items.push_back (MenuElem (_("Select"), *select_menu));
1991
1992         /* Cut-n-Paste */
1993
1994         Menu *cutnpaste_menu = manage (new Menu);
1995         MenuList& cutnpaste_items = cutnpaste_menu->items();
1996         cutnpaste_menu->set_name ("ArdourContextMenu");
1997
1998         cutnpaste_items.push_back (MenuElem (_("Cut"), mem_fun(*this, &Editor::cut)));
1999         cutnpaste_items.push_back (MenuElem (_("Copy"), mem_fun(*this, &Editor::copy)));
2000         cutnpaste_items.push_back (MenuElem (_("Paste"), bind (mem_fun(*this, &Editor::paste), 1.0f)));
2001
2002         cutnpaste_items.push_back (SeparatorElem());
2003
2004         cutnpaste_items.push_back (MenuElem (_("Align"), bind (mem_fun(*this, &Editor::align), ARDOUR::SyncPoint)));
2005         cutnpaste_items.push_back (MenuElem (_("Align Relative"), bind (mem_fun(*this, &Editor::align_relative), ARDOUR::SyncPoint)));
2006
2007         cutnpaste_items.push_back (SeparatorElem());
2008
2009         edit_items.push_back (MenuElem (_("Edit"), *cutnpaste_menu));
2010
2011         /* Adding new material */
2012
2013         edit_items.push_back (SeparatorElem());
2014         edit_items.push_back (MenuElem (_("Insert Selected Region"), bind (mem_fun(*this, &Editor::insert_region_list_selection), 1.0f)));
2015         edit_items.push_back (MenuElem (_("Insert Existing Media"), bind (mem_fun(*this, &Editor::add_external_audio_action), ImportToTrack)));
2016
2017         /* Nudge track */
2018
2019         Menu *nudge_menu = manage (new Menu());
2020         MenuList& nudge_items = nudge_menu->items();
2021         nudge_menu->set_name ("ArdourContextMenu");
2022
2023         edit_items.push_back (SeparatorElem());
2024         nudge_items.push_back (MenuElem (_("Nudge entire track fwd"), (bind (mem_fun(*this, &Editor::nudge_track), false, true))));
2025         nudge_items.push_back (MenuElem (_("Nudge track after edit point fwd"), (bind (mem_fun(*this, &Editor::nudge_track), true, true))));
2026         nudge_items.push_back (MenuElem (_("Nudge entire track bwd"), (bind (mem_fun(*this, &Editor::nudge_track), false, false))));
2027         nudge_items.push_back (MenuElem (_("Nudge track after edit point bwd"), (bind (mem_fun(*this, &Editor::nudge_track), true, false))));
2028
2029         edit_items.push_back (MenuElem (_("Nudge"), *nudge_menu));
2030 }
2031
2032 void
2033 Editor::add_bus_context_items (Menu_Helpers::MenuList& edit_items)
2034 {
2035         using namespace Menu_Helpers;
2036
2037         /* Playback */
2038
2039         Menu *play_menu = manage (new Menu);
2040         MenuList& play_items = play_menu->items();
2041         play_menu->set_name ("ArdourContextMenu");
2042
2043         play_items.push_back (MenuElem (_("Play from edit point"), mem_fun(*this, &Editor::play_from_edit_point)));
2044         play_items.push_back (MenuElem (_("Play from start"), mem_fun(*this, &Editor::play_from_start)));
2045         edit_items.push_back (MenuElem (_("Play"), *play_menu));
2046
2047         /* Selection */
2048
2049         Menu *select_menu = manage (new Menu);
2050         MenuList& select_items = select_menu->items();
2051         select_menu->set_name ("ArdourContextMenu");
2052
2053         select_items.push_back (MenuElem (_("Select All in track"), bind (mem_fun(*this, &Editor::select_all_in_track), Selection::Set)));
2054         select_items.push_back (MenuElem (_("Select All"), bind (mem_fun(*this, &Editor::select_all), Selection::Set)));
2055         select_items.push_back (MenuElem (_("Invert selection in track"), mem_fun(*this, &Editor::invert_selection_in_track)));
2056         select_items.push_back (MenuElem (_("Invert selection"), mem_fun(*this, &Editor::invert_selection)));
2057         select_items.push_back (SeparatorElem());
2058         select_items.push_back (MenuElem (_("Select all after edit point"), bind (mem_fun(*this, &Editor::select_all_selectables_using_edit), true)));
2059         select_items.push_back (MenuElem (_("Select all before edit point"), bind (mem_fun(*this, &Editor::select_all_selectables_using_edit), false)));
2060         select_items.push_back (MenuElem (_("Select all after playhead"), bind (mem_fun(*this, &Editor::select_all_selectables_using_cursor), playhead_cursor, true)));
2061         select_items.push_back (MenuElem (_("Select all before playhead"), bind (mem_fun(*this, &Editor::select_all_selectables_using_cursor), playhead_cursor, false)));
2062
2063         edit_items.push_back (MenuElem (_("Select"), *select_menu));
2064
2065         /* Cut-n-Paste */
2066
2067         Menu *cutnpaste_menu = manage (new Menu);
2068         MenuList& cutnpaste_items = cutnpaste_menu->items();
2069         cutnpaste_menu->set_name ("ArdourContextMenu");
2070
2071         cutnpaste_items.push_back (MenuElem (_("Cut"), mem_fun(*this, &Editor::cut)));
2072         cutnpaste_items.push_back (MenuElem (_("Copy"), mem_fun(*this, &Editor::copy)));
2073         cutnpaste_items.push_back (MenuElem (_("Paste"), bind (mem_fun(*this, &Editor::paste), 1.0f)));
2074
2075         Menu *nudge_menu = manage (new Menu());
2076         MenuList& nudge_items = nudge_menu->items();
2077         nudge_menu->set_name ("ArdourContextMenu");
2078
2079         edit_items.push_back (SeparatorElem());
2080         nudge_items.push_back (MenuElem (_("Nudge entire track fwd"), (bind (mem_fun(*this, &Editor::nudge_track), false, true))));
2081         nudge_items.push_back (MenuElem (_("Nudge track after edit point fwd"), (bind (mem_fun(*this, &Editor::nudge_track), true, true))));
2082         nudge_items.push_back (MenuElem (_("Nudge entire track bwd"), (bind (mem_fun(*this, &Editor::nudge_track), false, false))));
2083         nudge_items.push_back (MenuElem (_("Nudge track after edit point bwd"), (bind (mem_fun(*this, &Editor::nudge_track), true, false))));
2084
2085         edit_items.push_back (MenuElem (_("Nudge"), *nudge_menu));
2086 }
2087
2088 SnapType
2089 Editor::snap_type() const
2090 {
2091         return _snap_type;
2092 }
2093
2094 SnapMode
2095 Editor::snap_mode() const
2096 {
2097         return _snap_mode;
2098 }
2099
2100 void
2101 Editor::set_snap_to (SnapType st)
2102 {
2103         unsigned int snap_ind = (unsigned int)st;
2104
2105         _snap_type = st;
2106
2107         if (snap_ind > snap_type_strings.size() - 1) {
2108                 snap_ind = 0;
2109                 _snap_type = (SnapType)snap_ind;
2110         }
2111
2112         string str = snap_type_strings[snap_ind];
2113
2114         if (str != snap_type_selector.get_active_text()) {
2115                 snap_type_selector.set_active_text (str);
2116         }
2117
2118         instant_save ();
2119
2120         switch (_snap_type) {
2121         case SnapToAThirtysecondBeat:
2122         case SnapToASixteenthBeat:
2123         case SnapToAEighthBeat:
2124         case SnapToAQuarterBeat:
2125         case SnapToAThirdBeat:
2126                 compute_bbt_ruler_scale (leftmost_frame, leftmost_frame + current_page_frames());
2127                 update_tempo_based_rulers ();
2128                 break;
2129
2130         case SnapToRegionStart:
2131         case SnapToRegionEnd:
2132         case SnapToRegionSync:
2133         case SnapToRegionBoundary:
2134                 build_region_boundary_cache ();
2135                 break;
2136
2137         default:
2138                 /* relax */
2139                 break;
2140     }
2141 }
2142
2143 void
2144 Editor::set_snap_mode (SnapMode mode)
2145 {
2146         _snap_mode = mode;
2147         string str = snap_mode_strings[(int)mode];
2148
2149         if (str != snap_mode_selector.get_active_text ()) {
2150                 snap_mode_selector.set_active_text (str);
2151         }
2152
2153         instant_save ();
2154 }
2155 void
2156 Editor::set_edit_point_preference (EditPoint ep, bool force)
2157 {
2158         bool changed = (_edit_point != ep);
2159
2160         _edit_point = ep;
2161         string str = edit_point_strings[(int)ep];
2162
2163         if (str != edit_point_selector.get_active_text ()) {
2164                 edit_point_selector.set_active_text (str);
2165         }
2166
2167         set_canvas_cursor ();
2168
2169         if (!force && !changed) {
2170                 return;
2171         }
2172
2173         const char* action=NULL;
2174
2175         switch (_edit_point) {
2176         case EditAtPlayhead:
2177                 action = "edit-at-playhead";
2178                 break;
2179         case EditAtSelectedMarker:
2180                 action = "edit-at-marker";
2181                 break;
2182         case EditAtMouse:
2183                 action = "edit-at-mouse";
2184                 break;
2185         }
2186
2187         Glib::RefPtr<Action> act = ActionManager::get_action ("Editor", action);
2188         if (act) {
2189                 Glib::RefPtr<RadioAction>::cast_dynamic(act)->set_active (true);
2190         }
2191
2192         nframes64_t foo;
2193         bool in_track_canvas;
2194
2195         if (!mouse_frame (foo, in_track_canvas)) {
2196                 in_track_canvas = false;
2197         }
2198
2199         reset_canvas_action_sensitivity (in_track_canvas);
2200
2201         instant_save ();
2202 }
2203
2204 int
2205 Editor::set_state (const XMLNode& node, int /*version*/)
2206 {
2207         const XMLProperty* prop;
2208         XMLNode* geometry;
2209         int x, y, xoff, yoff;
2210         Gdk::Geometry g;
2211
2212         if ((prop = node.property ("id")) != 0) {
2213                 _id = prop->value ();
2214         }
2215
2216         g.base_width = default_width;
2217         g.base_height = default_height;
2218         x = 1;
2219         y = 1;
2220         xoff = 0;
2221         yoff = 21;
2222
2223         if ((geometry = find_named_node (node, "geometry")) != 0) {
2224
2225                 XMLProperty* prop;
2226
2227                 if ((prop = geometry->property("x_size")) == 0) {
2228                         prop = geometry->property ("x-size");
2229                 }
2230                 if (prop) {
2231                         g.base_width = atoi(prop->value());
2232                 }
2233                 if ((prop = geometry->property("y_size")) == 0) {
2234                         prop = geometry->property ("y-size");
2235                 }
2236                 if (prop) {
2237                         g.base_height = atoi(prop->value());
2238                 }
2239
2240                 if ((prop = geometry->property ("x_pos")) == 0) {
2241                         prop = geometry->property ("x-pos");
2242                 }
2243                 if (prop) {
2244                         x = atoi (prop->value());
2245
2246                 }
2247                 if ((prop = geometry->property ("y_pos")) == 0) {
2248                         prop = geometry->property ("y-pos");
2249                 }
2250                 if (prop) {
2251                         y = atoi (prop->value());
2252                 }
2253
2254                 if ((prop = geometry->property ("x_off")) == 0) {
2255                         prop = geometry->property ("x-off");
2256                 }
2257                 if (prop) {
2258                         xoff = atoi (prop->value());
2259                 }
2260                 if ((prop = geometry->property ("y_off")) == 0) {
2261                         prop = geometry->property ("y-off");
2262                 }
2263                 if (prop) {
2264                         yoff = atoi (prop->value());
2265                 }
2266         }
2267
2268         set_default_size (g.base_width, g.base_height);
2269         move (x, y);
2270
2271         if (session && (prop = node.property ("playhead"))) {
2272                 nframes64_t pos = atol (prop->value().c_str());
2273                 playhead_cursor->set_position (pos);
2274         } else {
2275                 playhead_cursor->set_position (0);
2276         }
2277         
2278         if ((prop = node.property ("mixer-width"))) {
2279                 editor_mixer_strip_width = Width (string_2_enum (prop->value(), editor_mixer_strip_width));
2280         }
2281
2282         if ((prop = node.property ("zoom-focus"))) {
2283                 set_zoom_focus ((ZoomFocus) atoi (prop->value()));
2284         }
2285
2286         if ((prop = node.property ("zoom"))) {
2287                 reset_zoom (PBD::atof (prop->value()));
2288         }
2289
2290         if ((prop = node.property ("snap-to"))) {
2291                 set_snap_to ((SnapType) atoi (prop->value()));
2292         }
2293
2294         if ((prop = node.property ("snap-mode"))) {
2295                 set_snap_mode ((SnapMode) atoi (prop->value()));
2296         }
2297
2298         if ((prop = node.property ("mouse-mode"))) {
2299                 MouseMode m = str2mousemode(prop->value());
2300                 mouse_mode = MouseMode ((int) m + 1); /* lie, force mode switch */
2301                 set_mouse_mode (m, true);
2302         } else {
2303                 mouse_mode = MouseGain; /* lie, to force the mode switch */
2304                 set_mouse_mode (MouseObject, true);
2305         }
2306
2307         if ((prop = node.property ("left-frame")) != 0){
2308                 nframes64_t pos;
2309                 if (sscanf (prop->value().c_str(), "%" PRId64, &pos) == 1) {
2310                         reset_x_origin (pos);
2311                         /* this hack prevents the initial call to update_current_screen() from doing re-centering on the playhead */
2312                         last_update_frame = pos;
2313                 }
2314         }
2315
2316         if ((prop = node.property ("internal-edit"))) {
2317                 bool yn = string_is_affirmative (prop->value());
2318                 RefPtr<Action> act = ActionManager::get_action (X_("MouseMode"), X_("toggle-internal-edit"));
2319                 if (act) {
2320                         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
2321                         tact->set_active (!yn);
2322                         tact->set_active (yn);
2323                 }
2324         }
2325
2326         if ((prop = node.property ("edit-point"))) {
2327                 set_edit_point_preference ((EditPoint) string_2_enum (prop->value(), _edit_point), true);
2328         }
2329
2330         if ((prop = node.property ("show-waveforms-recording"))) {
2331                 bool yn = string_is_affirmative (prop->value());
2332                 _show_waveforms_recording = !yn;
2333                 RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("ToggleWaveformsWhileRecording"));
2334                 if (act) {
2335                         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
2336                         /* do it twice to force the change */
2337                         tact->set_active (!yn);
2338                         tact->set_active (yn);
2339                 }
2340         }
2341
2342         if ((prop = node.property ("show-measures"))) {
2343                 bool yn = string_is_affirmative (prop->value());
2344                 _show_measures = !yn;
2345                 RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("ToggleMeasureVisibility"));
2346                 if (act) {
2347                         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
2348                         /* do it twice to force the change */
2349                         tact->set_active (!yn);
2350                         tact->set_active (yn);
2351                 }
2352         }
2353
2354         if ((prop = node.property ("follow-playhead"))) {
2355                 bool yn = string_is_affirmative (prop->value());
2356                 set_follow_playhead (yn);
2357                 RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-follow-playhead"));
2358                 if (act) {
2359                         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
2360                         if (tact->get_active() != yn) {
2361                                 tact->set_active (yn);
2362                         }
2363                 }
2364         }
2365
2366         if ((prop = node.property ("region-list-sort-type"))) {
2367                 _regions->reset_sort_type (str2regionlistsorttype(prop->value()), true);
2368         }
2369
2370         if ((prop = node.property ("xfades-visible"))) {
2371                 bool yn = string_is_affirmative (prop->value());
2372                 _xfade_visibility = !yn;
2373                 // set_xfade_visibility (yn);
2374         }
2375
2376         if ((prop = node.property ("show-editor-mixer"))) {
2377
2378                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("show-editor-mixer"));
2379                 if (act) {
2380
2381                         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
2382                         bool yn = string_is_affirmative (prop->value());
2383
2384                         /* do it twice to force the change */
2385
2386                         tact->set_active (!yn);
2387                         tact->set_active (yn);
2388                 }
2389         }
2390
2391         if ((prop = node.property ("show-editor-list"))) {
2392
2393                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("show-editor-list"));
2394                 assert(act);
2395                 if (act) {
2396
2397                         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
2398                         bool yn = string_is_affirmative (prop->value());
2399
2400                         /* do it twice to force the change */
2401
2402                         tact->set_active (!yn);
2403                         tact->set_active (yn);
2404                 }
2405         }
2406
2407
2408         return 0;
2409 }
2410
2411 XMLNode&
2412 Editor::get_state ()
2413 {
2414         XMLNode* node = new XMLNode ("Editor");
2415         char buf[32];
2416
2417         _id.print (buf, sizeof (buf));
2418         node->add_property ("id", buf);
2419
2420         if (is_realized()) {
2421                 Glib::RefPtr<Gdk::Window> win = get_window();
2422
2423                 int x, y, xoff, yoff, width, height;
2424                 win->get_root_origin(x, y);
2425                 win->get_position(xoff, yoff);
2426                 win->get_size(width, height);
2427
2428                 XMLNode* geometry = new XMLNode ("geometry");
2429
2430                 snprintf(buf, sizeof(buf), "%d", width);
2431                 geometry->add_property("x-size", string(buf));
2432                 snprintf(buf, sizeof(buf), "%d", height);
2433                 geometry->add_property("y-size", string(buf));
2434                 snprintf(buf, sizeof(buf), "%d", x);
2435                 geometry->add_property("x-pos", string(buf));
2436                 snprintf(buf, sizeof(buf), "%d", y);
2437                 geometry->add_property("y-pos", string(buf));
2438                 snprintf(buf, sizeof(buf), "%d", xoff);
2439                 geometry->add_property("x-off", string(buf));
2440                 snprintf(buf, sizeof(buf), "%d", yoff);
2441                 geometry->add_property("y-off", string(buf));
2442                 snprintf(buf,sizeof(buf), "%d",gtk_paned_get_position (static_cast<Paned*>(&edit_pane)->gobj()));
2443                 geometry->add_property("edit_pane_pos", string(buf));
2444
2445                 node->add_child_nocopy (*geometry);
2446         }
2447
2448         maybe_add_mixer_strip_width (*node);
2449
2450         snprintf (buf, sizeof(buf), "%d", (int) zoom_focus);
2451         node->add_property ("zoom-focus", buf);
2452         snprintf (buf, sizeof(buf), "%f", frames_per_unit);
2453         node->add_property ("zoom", buf);
2454         snprintf (buf, sizeof(buf), "%d", (int) _snap_type);
2455         node->add_property ("snap-to", buf);
2456         snprintf (buf, sizeof(buf), "%d", (int) _snap_mode);
2457         node->add_property ("snap-mode", buf);
2458
2459         node->add_property ("edit-point", enum_2_string (_edit_point));
2460
2461         snprintf (buf, sizeof (buf), "%" PRIi64, playhead_cursor->current_frame);
2462         node->add_property ("playhead", buf);
2463         snprintf (buf, sizeof (buf), "%" PRIi64, leftmost_frame);
2464         node->add_property ("left-frame", buf);
2465
2466         node->add_property ("show-waveforms-recording", _show_waveforms_recording ? "yes" : "no");
2467         node->add_property ("show-measures", _show_measures ? "yes" : "no");
2468         node->add_property ("follow-playhead", _follow_playhead ? "yes" : "no");
2469         node->add_property ("xfades-visible", _xfade_visibility ? "yes" : "no");
2470         node->add_property ("region-list-sort-type", enum2str (_regions->sort_type ()));
2471         node->add_property ("mouse-mode", enum2str(mouse_mode));
2472         node->add_property ("internal-edit", _internal_editing ? "yes" : "no");
2473
2474         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("show-editor-mixer"));
2475         if (act) {
2476                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
2477                 node->add_property (X_("show-editor-mixer"), tact->get_active() ? "yes" : "no");
2478         }
2479
2480         act = ActionManager::get_action (X_("Editor"), X_("show-editor-list"));
2481         if (act) {
2482                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
2483                 node->add_property (X_("show-editor-list"), tact->get_active() ? "yes" : "no");
2484         }
2485
2486         return *node;
2487 }
2488
2489
2490
2491 /** @param y y offset from the top of all trackviews.
2492  *  @return pair: TimeAxisView that y is over, layer index.
2493  *  TimeAxisView may be 0.  Layer index is the layer number if the TimeAxisView is valid and is
2494  *  in stacked region display mode, otherwise 0.
2495  */
2496 std::pair<TimeAxisView *, layer_t>
2497 Editor::trackview_by_y_position (double y)
2498 {
2499         for (TrackViewList::iterator iter = track_views.begin(); iter != track_views.end(); ++iter) {
2500
2501                 std::pair<TimeAxisView*, int> const r = (*iter)->covers_y_position (y);
2502                 if (r.first) {
2503                         return r;
2504                 }
2505         }
2506
2507         return std::make_pair ( (TimeAxisView *) 0, 0);
2508 }
2509
2510 /** Snap a position to the grid, if appropriate, taking into account current
2511  *  grid settings and also the state of any snap modifier keys that may be pressed.
2512  *  @param start Position to snap.
2513  *  @param event Event to get current key modifier information from.
2514  */
2515 void
2516 Editor::snap_to_with_modifier (nframes64_t& start, GdkEvent const * event, int32_t direction, bool for_mark)
2517 {
2518         if (!session) {
2519                 return;
2520         }
2521
2522         if (Keyboard::modifier_state_contains (event->button.state, Keyboard::snap_modifier())) {
2523                 if (_snap_mode == SnapOff) {
2524                         snap_to_internal (start, direction, for_mark);
2525                 }
2526         } else {
2527                 if (_snap_mode != SnapOff) {
2528                         snap_to_internal (start, direction, for_mark);
2529                 }
2530         }
2531 }
2532
2533 void
2534 Editor::snap_to (nframes64_t& start, int32_t direction, bool for_mark)
2535 {
2536         if (!session || _snap_mode == SnapOff) {
2537                 return;
2538         }
2539
2540         snap_to_internal (start, direction, for_mark);
2541 }
2542
2543 void
2544 Editor::timecode_snap_to_internal (nframes64_t& start, int32_t direction, bool /*for_mark*/)
2545 {
2546         const nframes64_t one_timecode_second = (nframes64_t)(rint(session->timecode_frames_per_second()) * session->frames_per_timecode_frame());
2547         nframes64_t one_timecode_minute = (nframes64_t)(rint(session->timecode_frames_per_second()) * session->frames_per_timecode_frame() * 60);
2548
2549         switch (_snap_type) {
2550         case SnapToTimecodeFrame:
2551                 if (((direction == 0) && (fmod((double)start, (double)session->frames_per_timecode_frame()) > (session->frames_per_timecode_frame() / 2))) || (direction > 0)) {
2552                         start = (nframes64_t) (ceil ((double) start / session->frames_per_timecode_frame()) * session->frames_per_timecode_frame());
2553                 } else {
2554                         start = (nframes64_t) (floor ((double) start / session->frames_per_timecode_frame()) *  session->frames_per_timecode_frame());
2555                 }
2556                 break;
2557
2558         case SnapToTimecodeSeconds:
2559                 if (session->timecode_offset_negative())
2560                 {
2561                         start += session->timecode_offset ();
2562                 } else {
2563                         start -= session->timecode_offset ();
2564                 }
2565                 if (((direction == 0) && (start % one_timecode_second > one_timecode_second / 2)) || direction > 0) {
2566                         start = (nframes64_t) ceil ((double) start / one_timecode_second) * one_timecode_second;
2567                 } else {
2568                         start = (nframes64_t) floor ((double) start / one_timecode_second) * one_timecode_second;
2569                 }
2570
2571                 if (session->timecode_offset_negative())
2572                 {
2573                         start -= session->timecode_offset ();
2574                 } else {
2575                         start += session->timecode_offset ();
2576                 }
2577                 break;
2578
2579         case SnapToTimecodeMinutes:
2580                 if (session->timecode_offset_negative())
2581                 {
2582                         start += session->timecode_offset ();
2583                 } else {
2584                         start -= session->timecode_offset ();
2585                 }
2586                 if (((direction == 0) && (start % one_timecode_minute > one_timecode_minute / 2)) || direction > 0) {
2587                         start = (nframes64_t) ceil ((double) start / one_timecode_minute) * one_timecode_minute;
2588                 } else {
2589                         start = (nframes64_t) floor ((double) start / one_timecode_minute) * one_timecode_minute;
2590                 }
2591                 if (session->timecode_offset_negative())
2592                 {
2593                         start -= session->timecode_offset ();
2594                 } else {
2595                         start += session->timecode_offset ();
2596                 }
2597                 break;
2598         default:
2599                 fatal << "Editor::smpte_snap_to_internal() called with non-timecode snap type!" << endmsg;
2600                 /*NOTREACHED*/
2601         }
2602 }
2603
2604 void
2605 Editor::snap_to_internal (nframes64_t& start, int32_t direction, bool for_mark)
2606 {
2607         const nframes64_t one_second = session->frame_rate();
2608         const nframes64_t one_minute = session->frame_rate() * 60;
2609         nframes64_t presnap = start;
2610         nframes64_t before;
2611         nframes64_t after;
2612
2613         switch (_snap_type) {
2614         case SnapToTimecodeFrame:
2615         case SnapToTimecodeSeconds:
2616         case SnapToTimecodeMinutes:
2617                 return timecode_snap_to_internal (start, direction, for_mark);
2618
2619         case SnapToCDFrame:
2620                 if (((direction == 0) && (start % (one_second/75) > (one_second/75) / 2)) || (direction > 0)) {
2621                         start = (nframes64_t) ceil ((double) start / (one_second / 75)) * (one_second / 75);
2622                 } else {
2623                         start = (nframes64_t) floor ((double) start / (one_second / 75)) * (one_second / 75);
2624                 }
2625                 break;
2626
2627         case SnapToSeconds:
2628                 if (((direction == 0) && (start % one_second > one_second / 2)) || (direction > 0)) {
2629                         start = (nframes64_t) ceil ((double) start / one_second) * one_second;
2630                 } else {
2631                         start = (nframes64_t) floor ((double) start / one_second) * one_second;
2632                 }
2633                 break;
2634
2635         case SnapToMinutes:
2636                 if (((direction == 0) && (start % one_minute > one_minute / 2)) || (direction > 0)) {
2637                         start = (nframes64_t) ceil ((double) start / one_minute) * one_minute;
2638                 } else {
2639                         start = (nframes64_t) floor ((double) start / one_minute) * one_minute;
2640                 }
2641                 break;
2642
2643         case SnapToBar:
2644                 start = session->tempo_map().round_to_bar (start, direction);
2645                 break;
2646
2647         case SnapToBeat:
2648                 start = session->tempo_map().round_to_beat (start, direction);
2649                 break;
2650
2651         case SnapToAThirtysecondBeat:
2652                 start = session->tempo_map().round_to_beat_subdivision (start, 32, direction);
2653                 break;
2654
2655         case SnapToASixteenthBeat:
2656                 start = session->tempo_map().round_to_beat_subdivision (start, 16, direction);
2657                 break;
2658
2659         case SnapToAEighthBeat:
2660                 start = session->tempo_map().round_to_beat_subdivision (start, 8, direction);
2661                 break;
2662
2663         case SnapToAQuarterBeat:
2664                 start = session->tempo_map().round_to_beat_subdivision (start, 4, direction);
2665                 break;
2666
2667         case SnapToAThirdBeat:
2668                 start = session->tempo_map().round_to_beat_subdivision (start, 3, direction);
2669                 break;
2670
2671         case SnapToMark:
2672                 if (for_mark) {
2673                         return;
2674                 }
2675
2676                 session->locations()->marks_either_side (start, before, after);
2677
2678                 if (before == max_frames) {
2679                         start = after;
2680                 } else if (after == max_frames) {
2681                         start = before;
2682                 } else if (before != max_frames && after != max_frames) {
2683                         /* have before and after */
2684                         if ((start - before) < (after - start)) {
2685                                 start = before;
2686                         } else {
2687                                 start = after;
2688                         }
2689                 }
2690
2691                 break;
2692
2693         case SnapToRegionStart:
2694         case SnapToRegionEnd:
2695         case SnapToRegionSync:
2696         case SnapToRegionBoundary:
2697                 if (!region_boundary_cache.empty()) {
2698
2699                         vector<nframes64_t>::iterator prev = region_boundary_cache.end ();
2700                         vector<nframes64_t>::iterator next = region_boundary_cache.end ();
2701
2702                         if (direction > 0) {
2703                                 next = std::upper_bound (region_boundary_cache.begin(), region_boundary_cache.end(), start);
2704                         } else {
2705                                 next = std::lower_bound (region_boundary_cache.begin(), region_boundary_cache.end(), start);
2706                         }
2707
2708                         if (next != region_boundary_cache.begin ()) {
2709                                 prev = next;
2710                                 prev--;
2711                         }
2712
2713                         nframes64_t const p = (prev == region_boundary_cache.end()) ? region_boundary_cache.front () : *prev;
2714                         nframes64_t const n = (next == region_boundary_cache.end()) ? region_boundary_cache.back () : *next;
2715
2716                         if (start > (p + n) / 2) {
2717                                 start = n;
2718                         } else {
2719                                 start = p;
2720                         }
2721                 }
2722                 break;
2723         }
2724
2725         switch (_snap_mode) {
2726         case SnapNormal:
2727                 return;
2728
2729         case SnapMagnetic:
2730
2731                 if (presnap > start) {
2732                         if (presnap > (start + unit_to_frame(snap_threshold))) {
2733                                 start = presnap;
2734                         }
2735
2736                 } else if (presnap < start) {
2737                         if (presnap < (start - unit_to_frame(snap_threshold))) {
2738                                 start = presnap;
2739                         }
2740                 }
2741
2742         default:
2743                 /* handled at entry */
2744                 return;
2745
2746         }
2747 }
2748
2749
2750 void
2751 Editor::setup_toolbar ()
2752 {
2753         string pixmap_path;
2754
2755         /* Mode Buttons (tool selection) */
2756
2757         mouse_move_button.set_relief(Gtk::RELIEF_NONE);
2758         mouse_select_button.set_relief(Gtk::RELIEF_NONE);
2759         mouse_gain_button.set_relief(Gtk::RELIEF_NONE);
2760         mouse_zoom_button.set_relief(Gtk::RELIEF_NONE);
2761         mouse_timefx_button.set_relief(Gtk::RELIEF_NONE);
2762         mouse_audition_button.set_relief(Gtk::RELIEF_NONE);
2763         // internal_edit_button.set_relief(Gtk::RELIEF_NONE);
2764
2765         HBox* mode_box = manage(new HBox);
2766         mode_box->set_border_width (2);
2767         mode_box->set_spacing(4);
2768         mouse_mode_button_box.set_spacing(1);
2769         mouse_mode_button_box.pack_start(mouse_move_button, true, true);
2770         if (!Profile->get_sae()) {
2771                 mouse_mode_button_box.pack_start(mouse_select_button, true, true);
2772         }
2773         mouse_mode_button_box.pack_start(mouse_zoom_button, true, true);
2774         if (!Profile->get_sae()) {
2775                 mouse_mode_button_box.pack_start(mouse_gain_button, true, true);
2776         }
2777         mouse_mode_button_box.pack_start(mouse_timefx_button, true, true);
2778         mouse_mode_button_box.pack_start(mouse_audition_button, true, true);
2779         mouse_mode_button_box.pack_start(internal_edit_button, true, true);
2780         mouse_mode_button_box.set_homogeneous(true);
2781
2782         vector<string> edit_mode_strings;
2783         edit_mode_strings.push_back (edit_mode_to_string (Slide));
2784         if (!Profile->get_sae()) {
2785                 edit_mode_strings.push_back (edit_mode_to_string (Splice));
2786         }
2787         edit_mode_strings.push_back (edit_mode_to_string (Lock));
2788
2789         edit_mode_selector.set_name ("EditModeSelector");
2790         set_popdown_strings (edit_mode_selector, edit_mode_strings, true);
2791         edit_mode_selector.signal_changed().connect (mem_fun(*this, &Editor::edit_mode_selection_done));
2792
2793         mode_box->pack_start(edit_mode_selector);
2794         mode_box->pack_start(mouse_mode_button_box);
2795
2796         mouse_mode_tearoff = manage (new TearOff (*mode_box));
2797         mouse_mode_tearoff->set_name ("MouseModeBase");
2798         mouse_mode_tearoff->tearoff_window().signal_key_press_event().connect (bind (sigc::ptr_fun (relay_key_press), &mouse_mode_tearoff->tearoff_window()), false);
2799
2800         if (Profile->get_sae()) {
2801                 mouse_mode_tearoff->set_can_be_torn_off (false);
2802         }
2803
2804         mouse_mode_tearoff->Detach.connect (bind (mem_fun(*this, &Editor::detach_tearoff), static_cast<Box*>(&toolbar_hbox),
2805                                                   &mouse_mode_tearoff->tearoff_window()));
2806         mouse_mode_tearoff->Attach.connect (bind (mem_fun(*this, &Editor::reattach_tearoff), static_cast<Box*> (&toolbar_hbox),
2807                                                   &mouse_mode_tearoff->tearoff_window(), 1));
2808         mouse_mode_tearoff->Hidden.connect (bind (mem_fun(*this, &Editor::detach_tearoff), static_cast<Box*>(&toolbar_hbox),
2809                                                   &mouse_mode_tearoff->tearoff_window()));
2810         mouse_mode_tearoff->Visible.connect (bind (mem_fun(*this, &Editor::reattach_tearoff), static_cast<Box*> (&toolbar_hbox),
2811                                                    &mouse_mode_tearoff->tearoff_window(), 1));
2812
2813         mouse_move_button.set_mode (false);
2814         mouse_select_button.set_mode (false);
2815         mouse_gain_button.set_mode (false);
2816         mouse_zoom_button.set_mode (false);
2817         mouse_timefx_button.set_mode (false);
2818         mouse_audition_button.set_mode (false);
2819
2820         mouse_move_button.set_name ("MouseModeButton");
2821         mouse_select_button.set_name ("MouseModeButton");
2822         mouse_gain_button.set_name ("MouseModeButton");
2823         mouse_zoom_button.set_name ("MouseModeButton");
2824         mouse_timefx_button.set_name ("MouseModeButton");
2825         mouse_audition_button.set_name ("MouseModeButton");
2826
2827         internal_edit_button.set_name ("MouseModeButton");
2828
2829         mouse_move_button.unset_flags (CAN_FOCUS);
2830         mouse_select_button.unset_flags (CAN_FOCUS);
2831         mouse_gain_button.unset_flags (CAN_FOCUS);
2832         mouse_zoom_button.unset_flags (CAN_FOCUS);
2833         mouse_timefx_button.unset_flags (CAN_FOCUS);
2834         mouse_audition_button.unset_flags (CAN_FOCUS);
2835         internal_edit_button.unset_flags (CAN_FOCUS);
2836
2837         /* Zoom */
2838
2839         zoom_box.set_spacing (1);
2840         zoom_box.set_border_width (0);
2841
2842         zoom_in_button.set_name ("EditorTimeButton");
2843         zoom_in_button.set_image (*(manage (new Image (Stock::ZOOM_IN, Gtk::ICON_SIZE_BUTTON))));
2844         zoom_in_button.signal_clicked().connect (bind (mem_fun(*this, &Editor::temporal_zoom_step), false));
2845         ARDOUR_UI::instance()->tooltips().set_tip (zoom_in_button, _("Zoom In"));
2846
2847         zoom_out_button.set_name ("EditorTimeButton");
2848         zoom_out_button.set_image (*(manage (new Image (Stock::ZOOM_OUT, Gtk::ICON_SIZE_BUTTON))));
2849         zoom_out_button.signal_clicked().connect (bind (mem_fun(*this, &Editor::temporal_zoom_step), true));
2850         ARDOUR_UI::instance()->tooltips().set_tip (zoom_out_button, _("Zoom Out"));
2851
2852         zoom_out_full_button.set_name ("EditorTimeButton");
2853         zoom_out_full_button.set_image (*(manage (new Image (Stock::ZOOM_100, Gtk::ICON_SIZE_BUTTON))));
2854         zoom_out_full_button.signal_clicked().connect (mem_fun(*this, &Editor::temporal_zoom_session));
2855         ARDOUR_UI::instance()->tooltips().set_tip (zoom_out_full_button, _("Zoom to Session"));
2856
2857         zoom_focus_selector.set_name ("ZoomFocusSelector");
2858         set_popdown_strings (zoom_focus_selector, zoom_focus_strings, true);
2859         zoom_focus_selector.signal_changed().connect (mem_fun(*this, &Editor::zoom_focus_selection_done));
2860         ARDOUR_UI::instance()->tooltips().set_tip (zoom_focus_selector, _("Zoom focus"));
2861
2862         zoom_box.pack_start (zoom_out_button, false, false);
2863         zoom_box.pack_start (zoom_in_button, false, false);
2864         zoom_box.pack_start (zoom_out_full_button, false, false);
2865
2866         /* Track zoom buttons */
2867         tav_expand_button.set_name ("TrackHeightButton");
2868         tav_expand_button.set_size_request(-1,20);
2869         tav_expand_button.add (*(manage (new Image (::get_icon("tav_exp")))));
2870         tav_expand_button.signal_clicked().connect (bind (mem_fun(*this, &Editor::tav_zoom_step), true));
2871         ARDOUR_UI::instance()->tooltips().set_tip (tav_expand_button, _("Expand Tracks"));
2872
2873         tav_shrink_button.set_name ("TrackHeightButton");
2874         tav_shrink_button.set_size_request(-1,20);
2875         tav_shrink_button.add (*(manage (new Image (::get_icon("tav_shrink")))));
2876         tav_shrink_button.signal_clicked().connect (bind (mem_fun(*this, &Editor::tav_zoom_step), false));
2877         ARDOUR_UI::instance()->tooltips().set_tip (tav_shrink_button, _("Shrink Tracks"));
2878
2879         track_zoom_box.set_spacing (1);
2880         track_zoom_box.set_border_width (0);
2881
2882         track_zoom_box.pack_start (tav_shrink_button, false, false);
2883         track_zoom_box.pack_start (tav_expand_button, false, false);
2884
2885         HBox* zbc = manage (new HBox);
2886         zbc->pack_start (zoom_focus_selector, PACK_SHRINK);
2887         zoom_vbox.pack_start (*zbc, PACK_SHRINK);
2888         zoom_vbox.pack_start (zoom_box, PACK_SHRINK);
2889         zoom_vbox.pack_start (track_zoom_box, PACK_SHRINK);
2890
2891         snap_box.set_spacing (1);
2892         snap_box.set_border_width (2);
2893
2894         snap_type_selector.set_name ("SnapTypeSelector");
2895         set_popdown_strings (snap_type_selector, snap_type_strings, true);
2896         snap_type_selector.signal_changed().connect (mem_fun(*this, &Editor::snap_type_selection_done));
2897         ARDOUR_UI::instance()->tooltips().set_tip (snap_type_selector, _("Snap/Grid Units"));
2898
2899         snap_mode_selector.set_name ("SnapModeSelector");
2900         set_popdown_strings (snap_mode_selector, snap_mode_strings, true);
2901         snap_mode_selector.signal_changed().connect (mem_fun(*this, &Editor::snap_mode_selection_done));
2902         ARDOUR_UI::instance()->tooltips().set_tip (snap_mode_selector, _("Snap/Grid Mode"));
2903
2904         edit_point_selector.set_name ("EditPointSelector");
2905         set_popdown_strings (edit_point_selector, edit_point_strings, true);
2906         edit_point_selector.signal_changed().connect (mem_fun(*this, &Editor::edit_point_selection_done));
2907         ARDOUR_UI::instance()->tooltips().set_tip (edit_point_selector, _("Edit point"));
2908
2909         snap_box.pack_start (snap_mode_selector, false, false);
2910         snap_box.pack_start (snap_type_selector, false, false);
2911         snap_box.pack_start (edit_point_selector, false, false);
2912
2913         /* Nudge */
2914
2915         HBox *nudge_box = manage (new HBox);
2916         nudge_box->set_spacing(1);
2917         nudge_box->set_border_width (2);
2918
2919         nudge_forward_button.signal_button_release_event().connect (mem_fun(*this, &Editor::nudge_forward_release), false);
2920         nudge_backward_button.signal_button_release_event().connect (mem_fun(*this, &Editor::nudge_backward_release), false);
2921
2922         nudge_box->pack_start (nudge_backward_button, false, false);
2923         nudge_box->pack_start (nudge_forward_button, false, false);
2924         nudge_box->pack_start (nudge_clock, false, false);
2925
2926
2927         /* Pack everything in... */
2928
2929         HBox* hbox = manage (new HBox);
2930         hbox->set_spacing(10);
2931
2932         tools_tearoff = manage (new TearOff (*hbox));
2933         tools_tearoff->set_name ("MouseModeBase");
2934         tools_tearoff->tearoff_window().signal_key_press_event().connect (bind (sigc::ptr_fun (relay_key_press), &tools_tearoff->tearoff_window()), false);
2935
2936         if (Profile->get_sae()) {
2937                 tools_tearoff->set_can_be_torn_off (false);
2938         }
2939
2940         tools_tearoff->Detach.connect (bind (mem_fun(*this, &Editor::detach_tearoff), static_cast<Box*>(&toolbar_hbox),
2941                                              &tools_tearoff->tearoff_window()));
2942         tools_tearoff->Attach.connect (bind (mem_fun(*this, &Editor::reattach_tearoff), static_cast<Box*> (&toolbar_hbox),
2943                                              &tools_tearoff->tearoff_window(), 0));
2944         tools_tearoff->Hidden.connect (bind (mem_fun(*this, &Editor::detach_tearoff), static_cast<Box*>(&toolbar_hbox),
2945                                              &tools_tearoff->tearoff_window()));
2946         tools_tearoff->Visible.connect (bind (mem_fun(*this, &Editor::reattach_tearoff), static_cast<Box*> (&toolbar_hbox),
2947                                               &tools_tearoff->tearoff_window(), 0));
2948
2949         toolbar_hbox.set_spacing (10);
2950         toolbar_hbox.set_border_width (1);
2951
2952         toolbar_hbox.pack_start (*mouse_mode_tearoff, false, false);
2953         toolbar_hbox.pack_start (*tools_tearoff, false, false);
2954
2955         hbox->pack_start (snap_box, false, false);
2956         hbox->pack_start (*nudge_box, false, false);
2957         hbox->pack_start (panic_box, false, false);
2958
2959         hbox->show_all ();
2960
2961         toolbar_base.set_name ("ToolBarBase");
2962         toolbar_base.add (toolbar_hbox);
2963
2964         toolbar_frame.set_shadow_type (SHADOW_OUT);
2965         toolbar_frame.set_name ("BaseFrame");
2966         toolbar_frame.add (toolbar_base);
2967 }
2968
2969 void
2970 Editor::midi_panic ()
2971 {
2972         cerr << "MIDI panic\n";
2973
2974         if (session) {
2975                 session->midi_panic();
2976         }
2977 }
2978
2979 void
2980 Editor::setup_midi_toolbar ()
2981 {
2982         RefPtr<Action> act;
2983
2984         /* Midi sound notes */
2985         midi_sound_notes.add (*(manage (new Image (::get_icon("midi_sound_notes")))));
2986         midi_sound_notes.set_relief(Gtk::RELIEF_NONE);
2987         ARDOUR_UI::instance()->tooltips().set_tip (midi_sound_notes, _("Sound Notes"));
2988         midi_sound_notes.unset_flags (CAN_FOCUS);
2989
2990         /* Panic */
2991
2992         act = ActionManager::get_action (X_("MIDI"), X_("panic"));
2993         midi_panic_button.set_name("MidiPanicButton");
2994         ARDOUR_UI::instance()->tooltips().set_tip (midi_panic_button, _("Send note off and reset controller messages on all MIDI channels"));
2995         act->connect_proxy (midi_panic_button);
2996
2997         panic_box.pack_start (midi_sound_notes , true, true);
2998         panic_box.pack_start (midi_panic_button, true, true);
2999 }
3000
3001 int
3002 Editor::convert_drop_to_paths (
3003                 vector<ustring>&                paths,
3004                 const RefPtr<Gdk::DragContext>& /*context*/,
3005                 gint                            /*x*/,
3006                 gint                            /*y*/,
3007                 const SelectionData&            data,
3008                 guint                           /*info*/,
3009                 guint                           /*time*/)
3010 {
3011         if (session == 0) {
3012                 return -1;
3013         }
3014
3015         vector<ustring> uris = data.get_uris();
3016
3017         if (uris.empty()) {
3018
3019                 /* This is seriously fucked up. Nautilus doesn't say that its URI lists
3020                    are actually URI lists. So do it by hand.
3021                 */
3022
3023                 if (data.get_target() != "text/plain") {
3024                         return -1;
3025                 }
3026
3027                 /* Parse the "uri-list" format that Nautilus provides,
3028                    where each pathname is delimited by \r\n.
3029
3030                    THERE MAY BE NO NULL TERMINATING CHAR!!!
3031                 */
3032
3033                 ustring txt = data.get_text();
3034                 const char* p;
3035                 const char* q;
3036
3037                 p = (const char *) malloc (txt.length() + 1);
3038                 txt.copy ((char *) p, txt.length(), 0);
3039                 ((char*)p)[txt.length()] = '\0';
3040
3041                 while (p)
3042                 {
3043                         if (*p != '#')
3044                         {
3045                                 while (g_ascii_isspace (*p))
3046                                         p++;
3047
3048                                 q = p;
3049                                 while (*q && (*q != '\n') && (*q != '\r')) {
3050                                         q++;
3051                                 }
3052
3053                                 if (q > p)
3054                                 {
3055                                         q--;
3056                                         while (q > p && g_ascii_isspace (*q))
3057                                                 q--;
3058
3059                                         if (q > p)
3060                                         {
3061                                                 uris.push_back (ustring (p, q - p + 1));
3062                                         }
3063                                 }
3064                         }
3065                         p = strchr (p, '\n');
3066                         if (p)
3067                                 p++;
3068                 }
3069
3070                 free ((void*)p);
3071
3072                 if (uris.empty()) {
3073                         return -1;
3074                 }
3075         }
3076
3077         for (vector<ustring>::iterator i = uris.begin(); i != uris.end(); ++i) {
3078
3079                 if ((*i).substr (0,7) == "file://") {
3080
3081                         ustring p = *i;
3082                         PBD::url_decode (p);
3083
3084                         // scan forward past three slashes
3085
3086                         ustring::size_type slashcnt = 0;
3087                         ustring::size_type n = 0;
3088                         ustring::iterator x = p.begin();
3089
3090                         while (slashcnt < 3 && x != p.end()) {
3091                                 if ((*x) == '/') {
3092                                         slashcnt++;
3093                                 } else if (slashcnt == 3) {
3094                                         break;
3095                                 }
3096                                 ++n;
3097                                 ++x;
3098                         }
3099
3100                         if (slashcnt != 3 || x == p.end()) {
3101                                 error << _("malformed URL passed to drag-n-drop code") << endmsg;
3102                                 continue;
3103                         }
3104
3105                         paths.push_back (p.substr (n - 1));
3106                 }
3107         }
3108
3109         return 0;
3110 }
3111
3112 void
3113 Editor::new_tempo_section ()
3114
3115 {
3116 }
3117
3118 void
3119 Editor::map_transport_state ()
3120 {
3121         ENSURE_GUI_THREAD (mem_fun(*this, &Editor::map_transport_state));
3122
3123         if (session->transport_stopped()) {
3124                 have_pending_keyboard_selection = false;
3125         }
3126
3127         update_loop_range_view (true);
3128 }
3129
3130 /* UNDO/REDO */
3131
3132 Editor::State::State (PublicEditor const * e)
3133 {
3134         selection = new Selection (e);
3135 }
3136
3137 Editor::State::~State ()
3138 {
3139         delete selection;
3140 }
3141
3142 void
3143 Editor::store_state (State& state) const
3144 {
3145         *state.selection = *selection;
3146 }
3147
3148 void
3149 Editor::restore_state (State *state)
3150 {
3151         if (*selection == *state->selection) {
3152                 return;
3153         }
3154
3155         *selection = *state->selection;
3156         time_selection_changed ();
3157         region_selection_changed ();
3158
3159         /* XXX other selection change handlers? */
3160 }
3161
3162 void
3163 Editor::begin_reversible_command (string name)
3164 {
3165         if (session) {
3166                 before = &get_state();
3167                 session->begin_reversible_command (name);
3168         }
3169 }
3170
3171 void
3172 Editor::commit_reversible_command ()
3173 {
3174         if (session) {
3175                 session->commit_reversible_command (new MementoCommand<Editor>(*this, before, &get_state()));
3176         }
3177 }
3178
3179 void
3180 Editor::set_route_group_solo (Route& route, bool yn)
3181 {
3182         RouteGroup *route_group;
3183
3184         if ((route_group = route.route_group()) != 0) {
3185                 route_group->apply (&Route::set_solo, yn, this);
3186         } else {
3187                 route.set_solo (yn, this);
3188         }
3189 }
3190
3191 void
3192 Editor::set_route_group_mute (Route& route, bool yn)
3193 {
3194         RouteGroup *route_group = 0;
3195
3196         if ((route_group == route.route_group()) != 0) {
3197                 route_group->apply (&Route::set_mute, yn, this);
3198         } else {
3199                 route.set_mute (yn, this);
3200         }
3201 }
3202
3203 void
3204 Editor::history_changed ()
3205 {
3206         string label;
3207
3208         if (undo_action && session) {
3209                 if (session->undo_depth() == 0) {
3210                         label = _("Undo");
3211                 } else {
3212                         label = string_compose(_("Undo (%1)"), session->next_undo());
3213                 }
3214                 undo_action->property_label() = label;
3215         }
3216
3217         if (redo_action && session) {
3218                 if (session->redo_depth() == 0) {
3219                         label = _("Redo");
3220                 } else {
3221                         label = string_compose(_("Redo (%1)"), session->next_redo());
3222                 }
3223                 redo_action->property_label() = label;
3224         }
3225 }
3226
3227 void
3228 Editor::duplicate_dialog (bool with_dialog)
3229 {
3230         float times = 1.0f;
3231
3232         if (mouse_mode == MouseRange) {
3233                 if (selection->time.length() == 0) {
3234                         return;
3235                 }
3236         }
3237
3238         RegionSelection rs;
3239         get_regions_for_action (rs);
3240
3241         if (mouse_mode != MouseRange) {
3242
3243                 if (rs.empty()) {
3244                         return;
3245                 }
3246         }
3247
3248         if (with_dialog) {
3249
3250                 ArdourDialog win ("Duplicate");
3251                 Label  label (_("Number of Duplications:"));
3252                 Adjustment adjustment (1.0, 1.0, 1000000.0, 1.0, 5.0);
3253                 SpinButton spinner (adjustment, 0.0, 1);
3254                 HBox hbox;
3255
3256                 win.get_vbox()->set_spacing (12);
3257                 win.get_vbox()->pack_start (hbox);
3258                 hbox.set_border_width (6);
3259                 hbox.pack_start (label, PACK_EXPAND_PADDING, 12);
3260
3261                 /* dialogs have ::add_action_widget() but that puts the spinner in the wrong
3262                    place, visually. so do this by hand.
3263                 */
3264
3265                 hbox.pack_start (spinner, PACK_EXPAND_PADDING, 12);
3266                 spinner.signal_activate().connect (sigc::bind (mem_fun (win, &ArdourDialog::response), RESPONSE_ACCEPT));
3267                 spinner.grab_focus();
3268
3269                 hbox.show ();
3270                 label.show ();
3271                 spinner.show ();
3272
3273                 win.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3274                 win.add_button (_("Duplicate"), RESPONSE_ACCEPT);
3275                 win.set_default_response (RESPONSE_ACCEPT);
3276
3277                 win.set_position (WIN_POS_MOUSE);
3278
3279                 spinner.grab_focus ();
3280
3281                 switch (win.run ()) {
3282                 case RESPONSE_ACCEPT:
3283                         break;
3284                 default:
3285                         return;
3286                 }
3287
3288                 times = adjustment.get_value();
3289         }
3290
3291         if (mouse_mode == MouseRange) {
3292                 duplicate_selection (times);
3293         } else {
3294                 duplicate_some_regions (rs, times);
3295         }
3296 }
3297
3298 void
3299 Editor::show_verbose_canvas_cursor ()
3300 {
3301         verbose_canvas_cursor->raise_to_top();
3302         verbose_canvas_cursor->show();
3303         verbose_cursor_visible = true;
3304 }
3305
3306 void
3307 Editor::hide_verbose_canvas_cursor ()
3308 {
3309         verbose_canvas_cursor->hide();
3310         verbose_cursor_visible = false;
3311 }
3312
3313 double
3314 Editor::clamp_verbose_cursor_x (double x)
3315 {
3316         if (x < 0) {
3317                 x = 0;
3318         } else {
3319                 x = min (_canvas_width - 200.0, x);
3320         }
3321         return x;
3322 }
3323
3324 double
3325 Editor::clamp_verbose_cursor_y (double y)
3326 {
3327         if (y < canvas_timebars_vsize) {
3328                 y = canvas_timebars_vsize;
3329         } else {
3330                 y = min (_canvas_height - 50, y);
3331         }
3332         return y;
3333 }
3334
3335 void
3336 Editor::show_verbose_canvas_cursor_with (const string & txt)
3337 {
3338         verbose_canvas_cursor->property_text() = txt.c_str();
3339
3340         int x, y;
3341         double wx, wy;
3342
3343         track_canvas->get_pointer (x, y);
3344         track_canvas->window_to_world (x, y, wx, wy);
3345
3346         /* don't get too close to the edge */
3347         verbose_canvas_cursor->property_x() = clamp_verbose_cursor_x (wx);
3348         verbose_canvas_cursor->property_y() = clamp_verbose_cursor_y (wy);
3349
3350         show_verbose_canvas_cursor ();
3351 }
3352
3353 void
3354 Editor::set_verbose_canvas_cursor (const string & txt, double x, double y)
3355 {
3356         verbose_canvas_cursor->property_text() = txt.c_str();
3357         /* don't get too close to the edge */
3358         verbose_canvas_cursor->property_x() = clamp_verbose_cursor_x (x);
3359         verbose_canvas_cursor->property_y() = clamp_verbose_cursor_y (y);
3360 }
3361
3362 void
3363 Editor::set_verbose_canvas_cursor_text (const string & txt)
3364 {
3365         verbose_canvas_cursor->property_text() = txt.c_str();
3366 }
3367
3368 void
3369 Editor::set_edit_mode (EditMode m)
3370 {
3371         Config->set_edit_mode (m);
3372 }
3373
3374 void
3375 Editor::cycle_edit_mode ()
3376 {
3377         switch (Config->get_edit_mode()) {
3378         case Slide:
3379                 if (Profile->get_sae()) {
3380                         Config->set_edit_mode (Lock);
3381                 } else {
3382                         Config->set_edit_mode (Splice);
3383                 }
3384                 break;
3385         case Splice:
3386                 Config->set_edit_mode (Lock);
3387                 break;
3388         case Lock:
3389                 Config->set_edit_mode (Slide);
3390                 break;
3391         }
3392 }
3393
3394 void
3395 Editor::edit_mode_selection_done ()
3396 {
3397         if (session == 0) {
3398                 return;
3399         }
3400
3401         string choice = edit_mode_selector.get_active_text();
3402         EditMode mode = Slide;
3403
3404         if (choice == _("Splice Edit")) {
3405                 mode = Splice;
3406         } else if (choice == _("Slide Edit")) {
3407                 mode = Slide;
3408         } else if (choice == _("Lock Edit")) {
3409                 mode = Lock;
3410         }
3411
3412         Config->set_edit_mode (mode);
3413 }
3414
3415 void
3416 Editor::snap_type_selection_done ()
3417 {
3418         string choice = snap_type_selector.get_active_text();
3419         SnapType snaptype = SnapToBeat;
3420
3421         if (choice == _("Beats/3")) {
3422                 snaptype = SnapToAThirdBeat;
3423         } else if (choice == _("Beats/4")) {
3424                 snaptype = SnapToAQuarterBeat;
3425         } else if (choice == _("Beats/8")) {
3426                 snaptype = SnapToAEighthBeat;
3427         } else if (choice == _("Beats/16")) {
3428                 snaptype = SnapToASixteenthBeat;
3429         } else if (choice == _("Beats/32")) {
3430                 snaptype = SnapToAThirtysecondBeat;
3431         } else if (choice == _("Beats")) {
3432                 snaptype = SnapToBeat;
3433         } else if (choice == _("Bars")) {
3434                 snaptype = SnapToBar;
3435         } else if (choice == _("Marks")) {
3436                 snaptype = SnapToMark;
3437         } else if (choice == _("Region starts")) {
3438                 snaptype = SnapToRegionStart;
3439         } else if (choice == _("Region ends")) {
3440                 snaptype = SnapToRegionEnd;
3441         } else if (choice == _("Region bounds")) {
3442                 snaptype = SnapToRegionBoundary;
3443         } else if (choice == _("Region syncs")) {
3444                 snaptype = SnapToRegionSync;
3445         } else if (choice == _("CD Frames")) {
3446                 snaptype = SnapToCDFrame;
3447         } else if (choice == _("Timecode Frames")) {
3448                 snaptype = SnapToTimecodeFrame;
3449         } else if (choice == _("Timecode Seconds")) {
3450                 snaptype = SnapToTimecodeSeconds;
3451         } else if (choice == _("Timecode Minutes")) {
3452                 snaptype = SnapToTimecodeMinutes;
3453         } else if (choice == _("Seconds")) {
3454                 snaptype = SnapToSeconds;
3455         } else if (choice == _("Minutes")) {
3456                 snaptype = SnapToMinutes;
3457         }
3458
3459         RefPtr<RadioAction> ract = snap_type_action (snaptype);
3460         if (ract) {
3461                 ract->set_active ();
3462         }
3463 }
3464
3465 void
3466 Editor::snap_mode_selection_done ()
3467 {
3468         string choice = snap_mode_selector.get_active_text();
3469         SnapMode mode = SnapNormal;
3470
3471         if (choice == _("No Grid")) {
3472                 mode = SnapOff;
3473         } else if (choice == _("Grid")) {
3474                 mode = SnapNormal;
3475         } else if (choice == _("Magnetic")) {
3476                 mode = SnapMagnetic;
3477         }
3478
3479         RefPtr<RadioAction> ract = snap_mode_action (mode);
3480
3481         if (ract) {
3482                 ract->set_active (true);
3483         }
3484 }
3485
3486 void
3487 Editor::cycle_edit_point (bool with_marker)
3488 {
3489         switch (_edit_point) {
3490         case EditAtMouse:
3491                 set_edit_point_preference (EditAtPlayhead);
3492                 break;
3493         case EditAtPlayhead:
3494                 if (with_marker) {
3495                         set_edit_point_preference (EditAtSelectedMarker);
3496                 } else {
3497                         set_edit_point_preference (EditAtMouse);
3498                 }
3499                 break;
3500         case EditAtSelectedMarker:
3501                 set_edit_point_preference (EditAtMouse);
3502                 break;
3503         }
3504 }
3505
3506 void
3507 Editor::edit_point_selection_done ()
3508 {
3509         string choice = edit_point_selector.get_active_text();
3510         EditPoint ep = EditAtSelectedMarker;
3511
3512         if (choice == _("Marker")) {
3513                 set_edit_point_preference (EditAtSelectedMarker);
3514         } else if (choice == _("Playhead")) {
3515                 set_edit_point_preference (EditAtPlayhead);
3516         } else {
3517                 set_edit_point_preference (EditAtMouse);
3518         }
3519
3520         RefPtr<RadioAction> ract = edit_point_action (ep);
3521
3522         if (ract) {
3523                 ract->set_active (true);
3524         }
3525 }
3526
3527 void
3528 Editor::zoom_focus_selection_done ()
3529 {
3530         string choice = zoom_focus_selector.get_active_text();
3531         ZoomFocus focus_type = ZoomFocusLeft;
3532
3533         if (choice == _("Left")) {
3534                 focus_type = ZoomFocusLeft;
3535         } else if (choice == _("Right")) {
3536                 focus_type = ZoomFocusRight;
3537         } else if (choice == _("Center")) {
3538                 focus_type = ZoomFocusCenter;
3539         } else if (choice == _("Playhead")) {
3540                 focus_type = ZoomFocusPlayhead;
3541         } else if (choice == _("Mouse")) {
3542                 focus_type = ZoomFocusMouse;
3543         } else if (choice == _("Edit point")) {
3544                 focus_type = ZoomFocusEdit;
3545         }
3546
3547         RefPtr<RadioAction> ract = zoom_focus_action (focus_type);
3548
3549         if (ract) {
3550                 ract->set_active ();
3551         }
3552 }
3553
3554 gint
3555 Editor::edit_controls_button_release (GdkEventButton* ev)
3556 {
3557         if (Keyboard::is_context_menu_event (ev)) {
3558                 ARDOUR_UI::instance()->add_route (this);
3559         }
3560         return TRUE;
3561 }
3562
3563 gint
3564 Editor::mouse_select_button_release (GdkEventButton* ev)
3565 {
3566         /* this handles just right-clicks */
3567
3568         if (ev->button != 3) {
3569                 return false;
3570         }
3571
3572         return true;
3573 }
3574
3575 Editor::TrackViewList *
3576 Editor::get_valid_views (TimeAxisView* track, RouteGroup* group)
3577 {
3578         TrackViewList::iterator i;
3579
3580         TrackViewList* v = new TrackViewList;
3581
3582         if (track == 0 && group == 0) {
3583
3584                 /* all views */
3585
3586                 for (i = track_views.begin(); i != track_views.end (); ++i) {
3587                         v->push_back (*i);
3588                 }
3589
3590         } else if ((track != 0 && group == 0) || (track != 0 && group != 0 && !group->active_property (RouteGroup::Select))) {
3591
3592                 /* just the view for this track
3593                  */
3594
3595                 v->push_back (track);
3596
3597         } else {
3598
3599                 /* views for all tracks in the route group */
3600
3601                 for (i = track_views.begin(); i != track_views.end (); ++i) {
3602
3603                         if (group == 0 || ((*i)->route_group() == group && group->active_property (RouteGroup::Select))) {
3604                                 v->push_back (*i);
3605                         }
3606                 }
3607         }
3608
3609         return v;
3610 }
3611
3612 void
3613 Editor::set_zoom_focus (ZoomFocus f)
3614 {
3615         string str = zoom_focus_strings[(int)f];
3616
3617         if (str != zoom_focus_selector.get_active_text()) {
3618                 zoom_focus_selector.set_active_text (str);
3619         }
3620
3621         if (zoom_focus != f) {
3622                 zoom_focus = f;
3623
3624                 ZoomFocusChanged (); /* EMIT_SIGNAL */
3625
3626                 instant_save ();
3627         }
3628 }
3629
3630 void
3631 Editor::ensure_float (Window& win)
3632 {
3633         win.set_transient_for (*this);
3634 }
3635
3636 void
3637 Editor::pane_allocation_handler (Allocation &alloc, Paned* which)
3638 {
3639         /* recover or initialize pane positions. do this here rather than earlier because
3640            we don't want the positions to change the child allocations, which they seem to do.
3641          */
3642
3643         int pos;
3644         XMLProperty* prop;
3645         char buf[32];
3646         XMLNode* node = ARDOUR_UI::instance()->editor_settings();
3647         int width, height;
3648         static int32_t done;
3649         XMLNode* geometry;
3650
3651         width = default_width;
3652         height = default_height;
3653
3654         if ((geometry = find_named_node (*node, "geometry")) != 0) {
3655
3656                 if ((prop = geometry->property ("x_size")) == 0) {
3657                         prop = geometry->property ("x-size");
3658                 }
3659                 if (prop) {
3660                         width = atoi (prop->value());
3661                 }
3662                 if ((prop = geometry->property ("y_size")) == 0) {
3663                         prop = geometry->property ("y-size");
3664                 }
3665                 if (prop) {
3666                         height = atoi (prop->value());
3667                 }
3668         }
3669
3670         if (which == static_cast<Paned*> (&edit_pane)) {
3671
3672                 if (done) {
3673                         return;
3674                 }
3675
3676                 if (!geometry || (prop = geometry->property ("edit-pane-pos")) == 0) {
3677                         /* initial allocation is 90% to canvas, 10% to notebook */
3678                         pos = (int) floor (alloc.get_width() * 0.90f);
3679                         snprintf (buf, sizeof(buf), "%d", pos);
3680                 } else {
3681                         pos = atoi (prop->value());
3682                 }
3683
3684                 if ((done = GTK_WIDGET(edit_pane.gobj())->allocation.width > pos)) {
3685                         edit_pane.set_position (pos);
3686                         pre_maximal_pane_position = pos;
3687                 }
3688         }
3689 }
3690
3691 void
3692 Editor::detach_tearoff (Box* /*b*/, Window* /*w*/)
3693 {
3694         cerr << "remove tearoff\n";
3695
3696         if (tools_tearoff->torn_off() &&
3697             mouse_mode_tearoff->torn_off()) {
3698                 top_hbox.remove (toolbar_frame);
3699         }
3700 }
3701
3702 void
3703 Editor::reattach_tearoff (Box* /*b*/, Window* /*w*/, int32_t /*n*/)
3704 {
3705         cerr << "reattach tearoff\n";
3706         if (toolbar_frame.get_parent() == 0) {
3707                 top_hbox.pack_end (toolbar_frame);
3708         }
3709 }
3710
3711 void
3712 Editor::set_show_measures (bool yn)
3713 {
3714         if (_show_measures != yn) {
3715                 hide_measures ();
3716
3717                 if ((_show_measures = yn) == true) {
3718                         if (tempo_lines)
3719                                 tempo_lines->show();
3720                         draw_measures ();
3721                 }
3722                 instant_save ();
3723         }
3724 }
3725
3726 void
3727 Editor::toggle_follow_playhead ()
3728 {
3729         RefPtr<Action> act = ActionManager::get_action (X_("Editor"), X_("toggle-follow-playhead"));
3730         if (act) {
3731                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
3732                 set_follow_playhead (tact->get_active());
3733         }
3734 }
3735
3736 void
3737 Editor::set_follow_playhead (bool yn)
3738 {
3739         if (_follow_playhead != yn) {
3740                 if ((_follow_playhead = yn) == true) {
3741                         /* catch up */
3742                         update_current_screen ();
3743                 }
3744                 instant_save ();
3745         }
3746 }
3747
3748 void
3749 Editor::toggle_xfade_active (boost::weak_ptr<Crossfade> wxfade)
3750 {
3751         boost::shared_ptr<Crossfade> xfade (wxfade.lock());
3752         if (xfade) {
3753                 xfade->set_active (!xfade->active());
3754         }
3755 }
3756
3757 void
3758 Editor::toggle_xfade_length (boost::weak_ptr<Crossfade> wxfade)
3759 {
3760         boost::shared_ptr<Crossfade> xfade (wxfade.lock());
3761         if (xfade) {
3762                 xfade->set_follow_overlap (!xfade->following_overlap());
3763         }
3764 }
3765
3766 void
3767 Editor::edit_xfade (boost::weak_ptr<Crossfade> wxfade)
3768 {
3769         boost::shared_ptr<Crossfade> xfade (wxfade.lock());
3770
3771         if (!xfade) {
3772                 return;
3773         }
3774
3775         CrossfadeEditor cew (*session, xfade, xfade->fade_in().get_min_y(), 1.0);
3776
3777         ensure_float (cew);
3778
3779         switch (cew.run ()) {
3780         case RESPONSE_ACCEPT:
3781                 break;
3782         default:
3783                 return;
3784         }
3785
3786         cew.apply ();
3787         xfade->StateChanged (Change (~0));
3788 }
3789
3790 PlaylistSelector&
3791 Editor::playlist_selector () const
3792 {
3793         return *_playlist_selector;
3794 }
3795
3796 Evoral::MusicalTime
3797 Editor::get_grid_type_as_beats (bool& success, nframes64_t position)
3798 {
3799         success = true;
3800
3801         switch (_snap_type) {
3802         case SnapToBeat:
3803                 return 1.0;
3804                 break;
3805
3806         case SnapToAThirtysecondBeat:
3807                 return 1.0/32.0;
3808                 break;
3809
3810         case SnapToASixteenthBeat:
3811                 return 1.0/16.0;
3812                 break;
3813
3814         case SnapToAEighthBeat:
3815                 return 1.0/8.0;
3816                 break;
3817
3818         case SnapToAQuarterBeat:
3819                 return 1.0/4.0;
3820                 break;
3821
3822         case SnapToAThirdBeat:
3823                 return 1.0/3.0;
3824                 break;
3825
3826         case SnapToBar:
3827                 if (session) {
3828                         return session->tempo_map().meter_at (position).beats_per_bar();
3829                 }
3830                 break;
3831
3832         case SnapToCDFrame:
3833         case SnapToTimecodeFrame:
3834         case SnapToTimecodeSeconds:
3835         case SnapToTimecodeMinutes:
3836         case SnapToSeconds:
3837         case SnapToMinutes:
3838         case SnapToRegionStart:
3839         case SnapToRegionEnd:
3840         case SnapToRegionSync:
3841         case SnapToRegionBoundary:
3842         default:
3843                 success = false;
3844                 break;
3845         }
3846
3847         return 0.0;
3848 }
3849
3850 nframes64_t
3851 Editor::get_nudge_distance (nframes64_t pos, nframes64_t& next)
3852 {
3853         nframes64_t ret;
3854
3855         ret = nudge_clock.current_duration (pos);
3856         next = ret + 1; /* XXXX fix me */
3857
3858         return ret;
3859 }
3860
3861 void
3862 Editor::end_location_changed (Location* location)
3863 {
3864         ENSURE_GUI_THREAD (bind (mem_fun(*this, &Editor::end_location_changed), location));
3865         //reset_scrolling_region ();
3866         nframes64_t session_span = location->start() + (nframes64_t) floorf (current_page_frames() * 0.10f);
3867         horizontal_adjustment.set_upper (session_span / frames_per_unit);
3868 }
3869
3870 int
3871 Editor::playlist_deletion_dialog (boost::shared_ptr<Playlist> pl)
3872 {
3873         ArdourDialog dialog ("playlist deletion dialog");
3874         Label  label (string_compose (_("Playlist %1 is currently unused.\n"
3875                                         "If left alone, no audio files used by it will be cleaned.\n"
3876                                         "If deleted, audio files used by it alone by will cleaned."),
3877                                       pl->name()));
3878
3879         dialog.set_position (WIN_POS_CENTER);
3880         dialog.get_vbox()->pack_start (label);
3881
3882         label.show ();
3883
3884         dialog.add_button (_("Delete playlist"), RESPONSE_ACCEPT);
3885         dialog.add_button (_("Keep playlist"), RESPONSE_REJECT);
3886         dialog.add_button (_("Cancel"), RESPONSE_CANCEL);
3887
3888         switch (dialog.run ()) {
3889         case RESPONSE_ACCEPT:
3890                 /* delete the playlist */
3891                 return 0;
3892                 break;
3893
3894         case RESPONSE_REJECT:
3895                 /* keep the playlist */
3896                 return 1;
3897                 break;
3898
3899         default:
3900                 break;
3901         }
3902
3903         return -1;
3904 }
3905
3906 bool
3907 Editor::audio_region_selection_covers (nframes64_t where)
3908 {
3909         for (RegionSelection::iterator a = selection->regions.begin(); a != selection->regions.end(); ++a) {
3910                 if ((*a)->region()->covers (where)) {
3911                         return true;
3912                 }
3913         }
3914
3915         return false;
3916 }
3917
3918 void
3919 Editor::prepare_for_cleanup ()
3920 {
3921         cut_buffer->clear_regions ();
3922         cut_buffer->clear_playlists ();
3923
3924         selection->clear_regions ();
3925         selection->clear_playlists ();
3926
3927         _regions->suspend_redisplay ();
3928 }
3929
3930 void
3931 Editor::finish_cleanup ()
3932 {
3933         _regions->resume_redisplay ();
3934 }
3935
3936 Location*
3937 Editor::transport_loop_location()
3938 {
3939         if (session) {
3940                 return session->locations()->auto_loop_location();
3941         } else {
3942                 return 0;
3943         }
3944 }
3945
3946 Location*
3947 Editor::transport_punch_location()
3948 {
3949         if (session) {
3950                 return session->locations()->auto_punch_location();
3951         } else {
3952                 return 0;
3953         }
3954 }
3955
3956 bool
3957 Editor::control_layout_scroll (GdkEventScroll* ev)
3958 {
3959         switch (ev->direction) {
3960         case GDK_SCROLL_UP:
3961                 scroll_tracks_up_line ();
3962                 return true;
3963                 break;
3964
3965         case GDK_SCROLL_DOWN:
3966                 scroll_tracks_down_line ();
3967                 return true;
3968
3969         default:
3970                 /* no left/right handling yet */
3971                 break;
3972         }
3973
3974         return false;
3975 }
3976
3977 void
3978 Editor::session_state_saved (string snap_name)
3979 {
3980         ENSURE_GUI_THREAD (bind (mem_fun(*this, &Editor::session_state_saved), snap_name));
3981
3982         _snapshots->redisplay ();
3983 }
3984
3985 void
3986 Editor::maximise_editing_space ()
3987 {
3988         mouse_mode_tearoff->set_visible (false);
3989         tools_tearoff->set_visible (false);
3990
3991         pre_maximal_pane_position = edit_pane.get_position();
3992         pre_maximal_editor_width = this->get_width();
3993
3994         if(post_maximal_pane_position == 0) {
3995                 post_maximal_pane_position = edit_pane.get_width();
3996         }
3997
3998         fullscreen();
3999
4000         if(post_maximal_editor_width) {
4001                 edit_pane.set_position (post_maximal_pane_position -
4002                         abs(post_maximal_editor_width - pre_maximal_editor_width));
4003         } else {
4004                 edit_pane.set_position (post_maximal_pane_position);
4005         }
4006 }
4007
4008 void
4009 Editor::restore_editing_space ()
4010 {
4011         // user changed width of pane during fullscreen
4012
4013         if(post_maximal_pane_position != edit_pane.get_position()) {
4014                 post_maximal_pane_position = edit_pane.get_position();
4015         }
4016
4017         unfullscreen();
4018
4019         mouse_mode_tearoff->set_visible (true);
4020         tools_tearoff->set_visible (true);
4021         post_maximal_editor_width = this->get_width();
4022
4023         edit_pane.set_position (pre_maximal_pane_position + abs(this->get_width() - pre_maximal_editor_width));
4024 }
4025
4026 /**
4027  *  Make new playlists for a given track and also any others that belong
4028  *  to the same active route group with the `edit' property.
4029  *  @param v Track.
4030  */
4031
4032 void
4033 Editor::new_playlists (TimeAxisView* v)
4034 {
4035         begin_reversible_command (_("new playlists"));
4036         vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
4037         session->playlists->get (playlists);
4038         mapover_tracks (bind (mem_fun (*this, &Editor::mapped_use_new_playlist), playlists), v, RouteGroup::Edit);
4039         commit_reversible_command ();
4040 }
4041
4042 /**
4043  *  Use a copy of the current playlist for a given track and also any others that belong
4044  *  to the same active route group with the `edit' property.
4045  *  @param v Track.
4046  */
4047
4048 void
4049 Editor::copy_playlists (TimeAxisView* v)
4050 {
4051         begin_reversible_command (_("copy playlists"));
4052         vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
4053         session->playlists->get (playlists);
4054         mapover_tracks (bind (mem_fun (*this, &Editor::mapped_use_copy_playlist), playlists), v, RouteGroup::Edit);
4055         commit_reversible_command ();
4056 }
4057
4058 /** Clear the current playlist for a given track and also any others that belong
4059  *  to the same active route group with the `edit' property.
4060  *  @param v Track.
4061  */
4062
4063 void
4064 Editor::clear_playlists (TimeAxisView* v)
4065 {
4066         begin_reversible_command (_("clear playlists"));
4067         vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
4068         session->playlists->get (playlists);
4069         mapover_tracks (mem_fun (*this, &Editor::mapped_clear_playlist), v, RouteGroup::Edit);
4070         commit_reversible_command ();
4071 }
4072
4073 void
4074 Editor::mapped_use_new_playlist (RouteTimeAxisView& atv, uint32_t sz, vector<boost::shared_ptr<ARDOUR::Playlist> > const & playlists)
4075 {
4076         atv.use_new_playlist (sz > 1 ? false : true, playlists);
4077 }
4078
4079 void
4080 Editor::mapped_use_copy_playlist (RouteTimeAxisView& atv, uint32_t sz, vector<boost::shared_ptr<ARDOUR::Playlist> > const & playlists)
4081 {
4082         atv.use_copy_playlist (sz > 1 ? false : true, playlists);
4083 }
4084
4085 void
4086 Editor::mapped_clear_playlist (RouteTimeAxisView& atv, uint32_t /*sz*/)
4087 {
4088         atv.clear_playlist ();
4089 }
4090
4091 bool
4092 Editor::on_key_press_event (GdkEventKey* ev)
4093 {
4094         return key_press_focus_accelerator_handler (*this, ev);
4095 }
4096
4097 bool
4098 Editor::on_key_release_event (GdkEventKey* ev)
4099 {
4100         return Gtk::Window::on_key_release_event (ev);
4101         // return key_press_focus_accelerator_handler (*this, ev);
4102 }
4103
4104 void
4105 Editor::reset_x_origin (nframes64_t frame)
4106 {
4107         //cerr << "resetting x origin" << endl;
4108         queue_visual_change (frame);
4109 }
4110
4111 void
4112 Editor::reset_y_origin (double y)
4113 {
4114         queue_visual_change_y (y);
4115 }
4116
4117 void
4118 Editor::reset_zoom (double fpu)
4119 {
4120         queue_visual_change (fpu);
4121 }
4122
4123 void
4124 Editor::reposition_and_zoom (nframes64_t frame, double fpu)
4125 {
4126         //cerr << "Editor::reposition_and_zoom () called ha v:l:u:ps:fpu = " << horizontal_adjustment.get_value() << ":" << horizontal_adjustment.get_lower() << ":" << horizontal_adjustment.get_upper() << ":" << horizontal_adjustment.get_page_size() << ":" << frames_per_unit << endl;//DEBUG
4127         reset_x_origin (frame);
4128         reset_zoom (fpu);
4129
4130         if (!no_save_visual) {
4131                 undo_visual_stack.push_back (current_visual_state(false));
4132         }
4133 }
4134
4135 Editor::VisualState*
4136 Editor::current_visual_state (bool with_tracks)
4137 {
4138         VisualState* vs = new VisualState;
4139         vs->y_position = vertical_adjustment.get_value();
4140         vs->frames_per_unit = frames_per_unit;
4141         vs->leftmost_frame = leftmost_frame;
4142         vs->zoom_focus = zoom_focus;
4143
4144         if (with_tracks) {
4145                 for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
4146                         vs->track_states.push_back (TAVState ((*i), &(*i)->get_state()));
4147                 }
4148         }
4149
4150         return vs;
4151 }
4152
4153 void
4154 Editor::undo_visual_state ()
4155 {
4156         if (undo_visual_stack.empty()) {
4157                 return;
4158         }
4159
4160         VisualState* vs = undo_visual_stack.back();
4161         undo_visual_stack.pop_back();
4162         use_visual_state (*vs);
4163         redo_visual_stack.push_back (vs);
4164 }
4165
4166 void
4167 Editor::redo_visual_state ()
4168 {
4169         if (redo_visual_stack.empty()) {
4170                 return;
4171         }
4172
4173         VisualState* vs = redo_visual_stack.back();
4174         redo_visual_stack.pop_back();
4175         use_visual_state (*vs);
4176         undo_visual_stack.push_back (vs);
4177 }
4178
4179 void
4180 Editor::swap_visual_state ()
4181 {
4182         if (undo_visual_stack.empty()) {
4183                 redo_visual_state ();
4184         } else {
4185                 undo_visual_state ();
4186         }
4187 }
4188
4189 void
4190 Editor::use_visual_state (VisualState& vs)
4191 {
4192         no_save_visual = true;
4193
4194         _routes->suspend_redisplay ();
4195
4196         vertical_adjustment.set_value (vs.y_position);
4197
4198         set_zoom_focus (vs.zoom_focus);
4199         reposition_and_zoom (vs.leftmost_frame, vs.frames_per_unit);
4200
4201         for (list<TAVState>::iterator i = vs.track_states.begin(); i != vs.track_states.end(); ++i) {
4202                 TrackViewList::iterator t;
4203
4204                 /* check if the track still exists - it could have been deleted */
4205
4206                 if ((t = find (track_views.begin(), track_views.end(), i->first)) != track_views.end()) {
4207                         (*t)->set_state (*(i->second), Stateful::loading_state_version);
4208                 }
4209         }
4210
4211
4212         if (!vs.track_states.empty()) {
4213                 _routes->update_visibility ();
4214         }
4215
4216         _routes->resume_redisplay ();
4217
4218         no_save_visual = false;
4219 }
4220
4221 void
4222 Editor::set_frames_per_unit (double fpu)
4223 {
4224         /* this is the core function that controls the zoom level of the canvas. it is called
4225            whenever one or more calls are made to reset_zoom(). it executes in an idle handler.
4226         */
4227
4228         if (fpu == frames_per_unit) {
4229                 return;
4230         }
4231
4232         if (fpu < 2.0) {
4233                 fpu = 2.0;
4234         }
4235
4236
4237         /* don't allow zooms that fit more than the maximum number
4238            of frames into an 800 pixel wide space.
4239         */
4240
4241         if (max_frames / fpu < 800.0) {
4242                 return;
4243         }
4244
4245         if (tempo_lines)
4246                 tempo_lines->tempo_map_changed();
4247
4248         frames_per_unit = fpu;
4249         post_zoom ();
4250 }
4251
4252 void
4253 Editor::post_zoom ()
4254 {
4255         nframes64_t cef = 0;
4256
4257         // convert fpu to frame count
4258
4259         nframes64_t frames = (nframes64_t) floor (frames_per_unit * _canvas_width);
4260
4261         if (frames_per_unit != zoom_range_clock.current_duration()) {
4262                 zoom_range_clock.set (frames);
4263         }
4264
4265         if (mouse_mode == MouseRange && selection->time.start () != selection->time.end_frame ()) {
4266                 if (!selection->tracks.empty()) {
4267                         for (TrackSelection::iterator i = selection->tracks.begin(); i != selection->tracks.end(); ++i) {
4268                                 (*i)->reshow_selection (selection->time);
4269                         }
4270                 } else {
4271                         for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
4272                                 (*i)->reshow_selection (selection->time);
4273                         }
4274                 }
4275         }
4276
4277         leftmost_frame = (nframes64_t) floor (horizontal_adjustment.get_value() * frames_per_unit);
4278
4279         ZoomChanged (); /* EMIT_SIGNAL */
4280
4281         if (session) {
4282                 cef = session->current_end_frame() + (current_page_frames() / 10);// Add a little extra so we can see the end marker
4283         }
4284         horizontal_adjustment.set_upper (cef / frames_per_unit);
4285
4286         //reset_scrolling_region ();
4287
4288         if (playhead_cursor) {
4289                 playhead_cursor->set_position (playhead_cursor->current_frame);
4290         }
4291
4292         refresh_location_display();
4293         _summary->set_overlays_dirty ();
4294
4295         instant_save ();
4296 }
4297
4298 void
4299 Editor::queue_visual_change (nframes64_t where)
4300 {
4301         pending_visual_change.add (VisualChange::TimeOrigin);
4302
4303         /* if we're moving beyond the end, make sure the upper limit of the horizontal adjustment
4304            can reach.
4305         */
4306
4307         if (session && (where > session->current_end_frame())) {
4308                 horizontal_adjustment.set_upper ((where + current_page_frames()) / frames_per_unit);
4309         }
4310
4311         pending_visual_change.time_origin = where;
4312
4313         ensure_visual_change_idle_handler ();
4314 }
4315
4316 void
4317 Editor::queue_visual_change (double fpu)
4318 {
4319         pending_visual_change.add (VisualChange::ZoomLevel);
4320         pending_visual_change.frames_per_unit = fpu;
4321
4322         ensure_visual_change_idle_handler ();
4323 }
4324
4325 void
4326 Editor::queue_visual_change_y (double y)
4327 {
4328         pending_visual_change.add (VisualChange::YOrigin);
4329         pending_visual_change.y_origin = y;
4330
4331         ensure_visual_change_idle_handler ();
4332 }
4333
4334 void
4335 Editor::ensure_visual_change_idle_handler ()
4336 {
4337         if (pending_visual_change.idle_handler_id < 0) {
4338                 pending_visual_change.idle_handler_id = g_idle_add (_idle_visual_changer, this);
4339         }
4340 }
4341
4342 int
4343 Editor::_idle_visual_changer (void* arg)
4344 {
4345         return static_cast<Editor*>(arg)->idle_visual_changer ();
4346 }
4347
4348 int
4349 Editor::idle_visual_changer ()
4350 {
4351         VisualChange::Type p = pending_visual_change.pending;
4352         pending_visual_change.pending = (VisualChange::Type) 0;
4353
4354         double last_time_origin = horizontal_adjustment.get_value();
4355
4356         if (p & VisualChange::ZoomLevel) {
4357                 set_frames_per_unit (pending_visual_change.frames_per_unit);
4358
4359                 compute_fixed_ruler_scale ();
4360                 compute_current_bbt_points(pending_visual_change.time_origin, pending_visual_change.time_origin + current_page_frames());
4361                 compute_bbt_ruler_scale (pending_visual_change.time_origin, pending_visual_change.time_origin + current_page_frames());
4362                 update_tempo_based_rulers ();
4363         }
4364         if (p & VisualChange::TimeOrigin) {
4365                 horizontal_adjustment.set_value (pending_visual_change.time_origin / frames_per_unit);
4366         }
4367         if (p & VisualChange::YOrigin) {
4368                 vertical_adjustment.set_value (pending_visual_change.y_origin);
4369         }
4370
4371         nframes64_t csf=0, cef=0;
4372         nframes64_t current_time_origin = (nframes64_t) floor (horizontal_adjustment.get_value() * frames_per_unit);
4373
4374         if (session) {
4375                 csf = session->current_start_frame();
4376                 cef = session->current_end_frame();
4377         }
4378
4379         /* if we seek beyond the current end of the canvas, move the end */
4380
4381
4382         if (last_time_origin == horizontal_adjustment.get_value() ) {
4383                 /* changed signal not emitted */
4384                 update_fixed_rulers ();
4385                 redisplay_tempo (true);
4386         }
4387
4388         if (current_time_origin != pending_visual_change.time_origin) {
4389                 cef += current_page_frames() / 10; // Add a little extra so we can see the end marker
4390                 horizontal_adjustment.set_upper (cef / frames_per_unit);
4391                 horizontal_adjustment.set_value (pending_visual_change.time_origin / frames_per_unit);
4392         } else {
4393                 update_fixed_rulers();
4394                 redisplay_tempo (true);
4395         }
4396
4397         _summary->set_overlays_dirty ();
4398
4399         // cerr << "Editor::idle_visual_changer () called ha v:l:u:ps:fpu = " << horizontal_adjustment.get_value() << ":" << horizontal_adjustment.get_lower() << ":" << horizontal_adjustment.get_upper() << ":" << horizontal_adjustment.get_page_size() << ":" << frames_per_unit << endl;//DEBUG
4400         pending_visual_change.idle_handler_id = -1;
4401         return 0; /* this is always a one-shot call */
4402 }
4403
4404 struct EditorOrderTimeAxisSorter {
4405     bool operator() (const TimeAxisView* a, const TimeAxisView* b) const {
4406             return a->order () < b->order ();
4407     }
4408 };
4409
4410 void
4411 Editor::sort_track_selection (TrackSelection* sel)
4412 {
4413         EditorOrderTimeAxisSorter cmp;
4414
4415         if (sel) {
4416                 sel->sort (cmp);
4417         } else {
4418                 selection->tracks.sort (cmp);
4419         }
4420 }
4421
4422 nframes64_t
4423 Editor::get_preferred_edit_position (bool ignore_playhead)
4424 {
4425         bool ignored;
4426         nframes64_t where = 0;
4427         EditPoint ep = _edit_point;
4428
4429         if (entered_marker) {
4430                 return entered_marker->position();
4431         }
4432
4433         if (ignore_playhead && ep == EditAtPlayhead) {
4434                 ep = EditAtSelectedMarker;
4435         }
4436
4437         switch (ep) {
4438         case EditAtPlayhead:
4439                 where = session->audible_frame();
4440                 break;
4441
4442         case EditAtSelectedMarker:
4443                 if (!selection->markers.empty()) {
4444                         bool is_start;
4445                         Location* loc = find_location_from_marker (selection->markers.front(), is_start);
4446                         if (loc) {
4447                                 if (is_start) {
4448                                         where =  loc->start();
4449                                 } else {
4450                                         where = loc->end();
4451                                 }
4452                                 break;
4453                         }
4454                 }
4455                 /* fallthru */
4456
4457         default:
4458         case EditAtMouse:
4459                 if (!mouse_frame (where, ignored)) {
4460                         /* XXX not right but what can we do ? */
4461                         return 0;
4462                 }
4463                 snap_to (where);
4464                 break;
4465         }
4466
4467         return where;
4468 }
4469
4470 void
4471 Editor::set_loop_range (nframes64_t start, nframes64_t end, string cmd)
4472 {
4473         if (!session) return;
4474
4475         begin_reversible_command (cmd);
4476
4477         Location* tll;
4478
4479         if ((tll = transport_loop_location()) == 0) {
4480                 Location* loc = new Location (start, end, _("Loop"),  Location::IsAutoLoop);
4481                 XMLNode &before = session->locations()->get_state();
4482                 session->locations()->add (loc, true);
4483                 session->set_auto_loop_location (loc);
4484                 XMLNode &after = session->locations()->get_state();
4485                 session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
4486         } else {
4487                 XMLNode &before = tll->get_state();
4488                 tll->set_hidden (false, this);
4489                 tll->set (start, end);
4490                 XMLNode &after = tll->get_state();
4491                 session->add_command (new MementoCommand<Location>(*tll, &before, &after));
4492         }
4493
4494         commit_reversible_command ();
4495 }
4496
4497 void
4498 Editor::set_punch_range (nframes64_t start, nframes64_t end, string cmd)
4499 {
4500         if (!session) return;
4501
4502         begin_reversible_command (cmd);
4503
4504         Location* tpl;
4505
4506         if ((tpl = transport_punch_location()) == 0) {
4507                 Location* loc = new Location (start, end, _("Loop"),  Location::IsAutoPunch);
4508                 XMLNode &before = session->locations()->get_state();
4509                 session->locations()->add (loc, true);
4510                 session->set_auto_loop_location (loc);
4511                 XMLNode &after = session->locations()->get_state();
4512                 session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
4513         }
4514         else {
4515                 XMLNode &before = tpl->get_state();
4516                 tpl->set_hidden (false, this);
4517                 tpl->set (start, end);
4518                 XMLNode &after = tpl->get_state();
4519                 session->add_command (new MementoCommand<Location>(*tpl, &before, &after));
4520         }
4521
4522         commit_reversible_command ();
4523 }
4524
4525 /** Find regions which exist at a given time, and optionally on a given list of tracks.
4526  *  @param rs List to which found regions are added.
4527  *  @param where Time to look at.
4528  *  @param ts Tracks to look on; if this is empty, all tracks are examined.
4529  */
4530 void
4531 Editor::get_regions_at (RegionSelection& rs, nframes64_t where, const TrackSelection& ts) const
4532 {
4533         const TrackSelection* tracks;
4534
4535         if (ts.empty()) {
4536                 tracks = &track_views;
4537         } else {
4538                 tracks = &ts;
4539         }
4540
4541         for (TrackSelection::const_iterator t = tracks->begin(); t != tracks->end(); ++t) {
4542                 RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(*t);
4543                 if (rtv) {
4544                         boost::shared_ptr<Diskstream> ds;
4545                         boost::shared_ptr<Playlist> pl;
4546
4547                         if ((ds = rtv->get_diskstream()) && ((pl = ds->playlist()))) {
4548
4549                                 Playlist::RegionList* regions = pl->regions_at (
4550                                                 (nframes64_t) floor ( (double)where * ds->speed()));
4551
4552                                 for (Playlist::RegionList::iterator i = regions->begin(); i != regions->end(); ++i) {
4553                                         RegionView* rv = rtv->view()->find_view (*i);
4554                                         if (rv) {
4555                                                 rs.add (rv);
4556                                         }
4557                                 }
4558
4559                                 delete regions;
4560                         }
4561                 }
4562         }
4563 }
4564
4565 void
4566 Editor::get_regions_after (RegionSelection& rs, nframes64_t where, const TrackSelection& ts) const
4567 {
4568         const TrackSelection* tracks;
4569
4570         if (ts.empty()) {
4571                 tracks = &track_views;
4572         } else {
4573                 tracks = &ts;
4574         }
4575
4576         for (TrackSelection::const_iterator t = tracks->begin(); t != tracks->end(); ++t) {
4577                 RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(*t);
4578                 if (rtv) {
4579                         boost::shared_ptr<Diskstream> ds;
4580                         boost::shared_ptr<Playlist> pl;
4581
4582                         if ((ds = rtv->get_diskstream()) && ((pl = ds->playlist()))) {
4583
4584                                 Playlist::RegionList* regions = pl->regions_touched (
4585                                                 (nframes64_t) floor ( (double)where * ds->speed()), max_frames);
4586
4587                                 for (Playlist::RegionList::iterator i = regions->begin(); i != regions->end(); ++i) {
4588
4589                                         RegionView* rv = rtv->view()->find_view (*i);
4590
4591                                         if (rv) {
4592                                                 rs.push_back (rv);
4593                                         }
4594                                 }
4595
4596                                 delete regions;
4597                         }
4598                 }
4599         }
4600 }
4601
4602 /** Find all regions which are either:
4603  *      - selected or
4604  *      - the entered_regionview (if allow_entered == true) or
4605  *      - under the preferred edit position AND on a selected track, or on a track
4606  *        which is in the same active edit-enable route group as a selected region (if allow_edit_position == true)
4607  *  @param rs Returned region list.
4608  *  @param allow_entered true to include the entered_regionview in the list.
4609  */
4610 void
4611 Editor::get_regions_for_action (RegionSelection& rs, bool allow_entered, bool allow_edit_position)
4612 {
4613         /* Start with selected regions */
4614         rs = selection->regions;
4615
4616         /* Add the entered_regionview, if requested */
4617         if (allow_entered && entered_regionview) {
4618                 rs.add (entered_regionview);
4619         }
4620
4621         if (allow_edit_position) {
4622
4623                 TrackSelection tracks = selection->tracks;
4624
4625                 /* tracks is currently the set of selected tracks; add any other tracks that
4626                  * have regions that are in the same edit-activated route group as one of
4627                  * our regions */
4628                 for (RegionSelection::iterator i = rs.begin (); i != rs.end(); ++i) {
4629
4630                         RouteGroup* g = (*i)->get_time_axis_view().route_group ();
4631                         if (g && g->active_property (RouteGroup::Edit)) {
4632                                 tracks.add (axis_views_from_routes (g->route_list()));
4633                         }
4634                 }
4635
4636                 /* now find regions that are at the edit position on those tracks */
4637                 nframes64_t const where = get_preferred_edit_position ();
4638                 get_regions_at (rs, where, tracks);
4639         }
4640 }
4641
4642 void
4643 Editor::get_regions_corresponding_to (boost::shared_ptr<Region> region, vector<RegionView*>& regions)
4644 {
4645         for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
4646
4647                 RouteTimeAxisView* tatv;
4648
4649                 if ((tatv = dynamic_cast<RouteTimeAxisView*> (*i)) != 0) {
4650
4651                         boost::shared_ptr<Playlist> pl;
4652                         vector<boost::shared_ptr<Region> > results;
4653                         RegionView* marv;
4654                         boost::shared_ptr<Diskstream> ds;
4655
4656                         if ((ds = tatv->get_diskstream()) == 0) {
4657                                 /* bus */
4658                                 continue;
4659                         }
4660
4661                         if ((pl = (ds->playlist())) != 0) {
4662                                 pl->get_region_list_equivalent_regions (region, results);
4663                         }
4664
4665                         for (vector<boost::shared_ptr<Region> >::iterator ir = results.begin(); ir != results.end(); ++ir) {
4666                                 if ((marv = tatv->view()->find_view (*ir)) != 0) {
4667                                         regions.push_back (marv);
4668                                 }
4669                         }
4670
4671                 }
4672         }
4673 }
4674
4675 void
4676 Editor::show_rhythm_ferret ()
4677 {
4678         if (rhythm_ferret == 0) {
4679                 rhythm_ferret = new RhythmFerret(*this);
4680         }
4681
4682         rhythm_ferret->set_session (session);
4683         rhythm_ferret->show ();
4684         rhythm_ferret->present ();
4685 }
4686
4687 void
4688 Editor::show_global_port_matrix (ARDOUR::DataType t)
4689 {
4690         if (_global_port_matrix[t] == 0) {
4691                 _global_port_matrix[t] = new GlobalPortMatrixWindow (session, t);
4692         }
4693
4694         _global_port_matrix[t]->show ();
4695 }
4696
4697 void
4698 Editor::first_idle ()
4699 {
4700         MessageDialog* dialog = 0;
4701
4702         if (track_views.size() > 1) {
4703                 dialog = new MessageDialog (*this,
4704                                             _("Please wait while Ardour loads visual data"),
4705                                             true,
4706                                             Gtk::MESSAGE_INFO,
4707                                             Gtk::BUTTONS_NONE);
4708                 dialog->present ();
4709                 ARDOUR_UI::instance()->flush_pending ();
4710         }
4711
4712         for (TrackViewList::iterator t = track_views.begin(); t != track_views.end(); ++t) {
4713                 (*t)->first_idle();
4714         }
4715
4716         // first idle adds route children (automation tracks), so we need to redisplay here
4717         _routes->redisplay ();
4718
4719         delete dialog;
4720
4721         _have_idled = true;
4722 }
4723
4724 static gboolean
4725 _idle_resizer (gpointer arg)
4726 {
4727         return ((Editor*)arg)->idle_resize ();
4728 }
4729
4730 void
4731 Editor::add_to_idle_resize (TimeAxisView* view, int32_t h)
4732 {
4733         if (resize_idle_id < 0) {
4734                 resize_idle_id = g_idle_add (_idle_resizer, this);
4735                 _pending_resize_amount = 0;
4736         }
4737
4738         /* make a note of the smallest resulting height, so that we can clamp the
4739            lower limit at TimeAxisView::hSmall */
4740
4741         int32_t min_resulting = INT32_MAX;
4742
4743         _pending_resize_amount += h;
4744         _pending_resize_view = view;
4745
4746         min_resulting = min (min_resulting, int32_t (_pending_resize_view->current_height()) + _pending_resize_amount);
4747
4748         if (selection->tracks.contains (_pending_resize_view)) {
4749                 for (TrackSelection::iterator i = selection->tracks.begin(); i != selection->tracks.end(); ++i) {
4750                         min_resulting = min (min_resulting, int32_t ((*i)->current_height()) + _pending_resize_amount);
4751                 }
4752         }
4753
4754         if (min_resulting < 0) {
4755                 min_resulting = 0;
4756         }
4757
4758         /* clamp */
4759         if (uint32_t (min_resulting) < TimeAxisView::hSmall) {
4760                 _pending_resize_amount += TimeAxisView::hSmall - min_resulting;
4761         }
4762 }
4763
4764 /** Handle pending resizing of tracks */
4765 bool
4766 Editor::idle_resize ()
4767 {
4768         _pending_resize_view->idle_resize (_pending_resize_view->current_height() + _pending_resize_amount);
4769
4770         if (dynamic_cast<AutomationTimeAxisView*> (_pending_resize_view) == 0 &&
4771             selection->tracks.contains (_pending_resize_view)) {
4772
4773                 for (TrackSelection::iterator i = selection->tracks.begin(); i != selection->tracks.end(); ++i) {
4774                         if (*i != _pending_resize_view) {
4775                                 (*i)->idle_resize ((*i)->current_height() + _pending_resize_amount);
4776                         }
4777                 }
4778         }
4779
4780         flush_canvas ();
4781         _group_tabs->set_dirty ();
4782         resize_idle_id = -1;
4783
4784         return false;
4785 }
4786
4787 void
4788 Editor::located ()
4789 {
4790         ENSURE_GUI_THREAD (mem_fun (*this, &Editor::located));
4791
4792         _pending_locate_request = false;
4793 }
4794
4795 void
4796 Editor::region_view_added (RegionView *)
4797 {
4798         _summary->set_dirty ();
4799 }
4800
4801 void
4802 Editor::streamview_height_changed ()
4803 {
4804         _summary->set_dirty ();
4805 }
4806
4807 TimeAxisView*
4808 Editor::axis_view_from_route (boost::shared_ptr<Route> r) const
4809 {
4810         TrackViewList::const_iterator j = track_views.begin ();
4811         while (j != track_views.end()) {
4812                 RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (*j);
4813                 if (rtv && rtv->route() == r) {
4814                         return rtv;
4815                 }
4816                 ++j;
4817         }
4818
4819         return 0;
4820 }
4821
4822
4823 TrackSelection
4824 Editor::axis_views_from_routes (boost::shared_ptr<RouteList> r) const
4825 {
4826         TrackSelection t;
4827
4828         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
4829                 TimeAxisView* tv = axis_view_from_route (*i);
4830                 if (tv) {
4831                         t.push_back (tv);
4832                 }
4833         }
4834
4835         return t;
4836 }
4837
4838
4839 void
4840 Editor::handle_new_route (RouteList& routes)
4841 {
4842         ENSURE_GUI_THREAD (bind (mem_fun (*this, &Editor::handle_new_route), routes));
4843
4844         RouteTimeAxisView *rtv;
4845         list<RouteTimeAxisView*> new_views;
4846
4847         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
4848                 boost::shared_ptr<Route> route = (*x);
4849
4850                 if (route->is_hidden()) {
4851                         continue;
4852                 }
4853
4854                 DataType dt = route->input()->default_type();
4855
4856                 if (dt == ARDOUR::DataType::AUDIO) {
4857                         rtv = new AudioTimeAxisView (*this, *session, route, *track_canvas);
4858                 } else if (dt == ARDOUR::DataType::MIDI) {
4859                         rtv = new MidiTimeAxisView (*this, *session, route, *track_canvas);
4860                 } else {
4861                         throw unknown_type();
4862                 }
4863
4864                 new_views.push_back (rtv);
4865                 track_views.push_back (rtv);
4866
4867                 rtv->effective_gain_display ();
4868
4869                 rtv->view()->RegionViewAdded.connect (mem_fun (*this, &Editor::region_view_added));
4870                 rtv->view()->HeightChanged.connect (mem_fun (*this, &Editor::streamview_height_changed));
4871
4872                 rtv->GoingAway.connect (bind (mem_fun(*this, &Editor::remove_route), rtv));
4873         }
4874
4875         _routes->routes_added (new_views);
4876
4877         if (show_editor_mixer_when_tracks_arrive) {
4878                 show_editor_mixer (true);
4879         }
4880
4881         editor_list_button.set_sensitive (true);
4882
4883         _summary->set_dirty ();
4884 }
4885
4886 void
4887 Editor::remove_route (TimeAxisView *tv)
4888 {
4889         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::remove_route), tv));
4890
4891         TrackViewList::iterator i;
4892
4893         boost::shared_ptr<Route> route;
4894         RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (tv);
4895         if (rtav) {
4896                 route = rtav->route ();
4897         }
4898                 
4899         TimeAxisView* next_tv = 0;
4900
4901         if (tv == entered_track) {
4902                 entered_track = 0;
4903         }
4904
4905         if ((i = find (track_views.begin(), track_views.end(), tv)) != track_views.end()) {
4906
4907                i = track_views.erase (i);
4908
4909                if (track_views.empty()) {
4910                        next_tv = 0;
4911                } else if (i == track_views.end()) {
4912                        next_tv = track_views.front();
4913                } else {
4914                       next_tv = (*i);
4915                }
4916         }
4917
4918         if (current_mixer_strip && current_mixer_strip->route() == route) {
4919
4920                if (next_tv) {
4921                        set_selected_mixer_strip (*next_tv);
4922                } else {
4923                        /* make the editor mixer strip go away setting the
4924                         * button to inactive (which also unticks the menu option)
4925                         */
4926
4927                        ActionManager::uncheck_toggleaction ("<Actions>/Editor/show-editor-mixer");
4928                }
4929         }
4930 }
4931
4932 void
4933 Editor::hide_track_in_display (TimeAxisView& tv, bool /*temponly*/)
4934 {
4935         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (&tv);
4936
4937         if (rtv && current_mixer_strip && (rtv->route() == current_mixer_strip->route())) {
4938                 // this will hide the mixer strip
4939                 set_selected_mixer_strip (tv);
4940         }
4941
4942         _routes->hide_track_in_display (tv);
4943 }
4944
4945 bool
4946 Editor::sync_track_view_list_and_routes ()
4947 {
4948         track_views = TrackSelection (_routes->views ());
4949
4950         _summary->set_dirty ();
4951         _group_tabs->set_dirty ();
4952
4953         return false; // do not call again (until needed)
4954 }
4955
4956 void
4957 Editor::foreach_time_axis_view (sigc::slot<void,TimeAxisView&> theslot)
4958 {
4959         for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
4960                 theslot (**i);
4961         }
4962 }
4963
4964 RouteTimeAxisView*
4965 Editor::get_route_view_by_id (PBD::ID& id)
4966 {
4967         RouteTimeAxisView* v;
4968
4969         for(TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
4970                 if((v = dynamic_cast<RouteTimeAxisView*>(*i)) != 0) {
4971                         if(v->route()->id() == id) {
4972                                 return v;
4973                         }
4974                 }
4975         }
4976
4977         return 0;
4978 }
4979
4980 void
4981 Editor::fit_route_group (RouteGroup *g)
4982 {
4983         TrackSelection ts = axis_views_from_routes (g->route_list ());
4984         fit_tracks (ts);
4985 }
4986
4987 void
4988 Editor::consider_auditioning (boost::shared_ptr<Region> region)
4989 {
4990         boost::shared_ptr<AudioRegion> r = boost::dynamic_pointer_cast<AudioRegion> (region);
4991
4992         if (r == 0) {
4993                 session->cancel_audition ();
4994                 return;
4995         }
4996
4997         if (session->is_auditioning()) {
4998                 session->cancel_audition ();
4999                 if (r == last_audition_region) {
5000                         return;
5001                 }
5002         }
5003
5004         session->audition_region (r);
5005         last_audition_region = r;
5006 }
5007
5008
5009 void
5010 Editor::hide_a_region (boost::shared_ptr<Region> r)
5011 {
5012         r->set_hidden (true);
5013 }
5014
5015 void
5016 Editor::remove_a_region (boost::shared_ptr<Region> r)
5017 {
5018         session->remove_region_from_region_list (r);
5019 }
5020
5021 void
5022 Editor::audition_region_from_region_list ()
5023 {
5024         _regions->selection_mapover (mem_fun (*this, &Editor::consider_auditioning));
5025 }
5026
5027 void
5028 Editor::hide_region_from_region_list ()
5029 {
5030         _regions->selection_mapover (mem_fun (*this, &Editor::hide_a_region));
5031 }
5032
5033 void
5034 Editor::start_step_editing ()
5035 {
5036         step_edit_connection = Glib::signal_timeout().connect (mem_fun (*this, &Editor::check_step_edit), 20);
5037 }
5038
5039 void
5040 Editor::stop_step_editing ()
5041 {
5042         step_edit_connection.disconnect ();
5043 }
5044
5045 bool
5046 Editor::check_step_edit ()
5047 {
5048         for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
5049                 MidiTimeAxisView* mtv = dynamic_cast<MidiTimeAxisView*> (*i);
5050                 if (mtv) {
5051                         mtv->check_step_edit ();
5052                 }
5053         }
5054
5055         return true; // do it again, till we stop
5056 }
5057
5058 void
5059 Editor::horizontal_scroll_left ()
5060 {
5061         double x = leftmost_position() - current_page_frames() / 5;
5062         if (x < 0) {
5063                 x = 0;
5064         }
5065         
5066         reset_x_origin (x);
5067 }
5068
5069 void
5070 Editor::horizontal_scroll_right ()
5071 {
5072         reset_x_origin (leftmost_position() + current_page_frames() / 5);
5073 }