gtk2_ardour/editor.h

   1 /*
   2     Copyright (C) 2000-2003 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 #ifndef __ardour_editor_h__
  21 #define __ardour_editor_h__
  22
  23 #include <sys/time.h>
  24
  25 #include <cmath>
  26 #include <list>
  27 #include <map>
  28 #include <set>
  29 #include <string>
  30 #include <vector>
  31
  32 #include <boost/optional.hpp>
  33
  34 #include <gtkmm/comboboxtext.h>
  35 #include <gtkmm/layout.h>
  36
  37 #include "gtkmm2ext/selector.h"
  38 #include "gtkmm2ext/click_box.h"
  39 #include "gtkmm2ext/dndtreeview.h"
  40 #include "gtkmm2ext/stateful_button.h"
  41 #include "gtkmm2ext/bindings.h"
  42
  43 #include "pbd/stateful.h"
  44 #include "pbd/signals.h"
  45
  46 #include "ardour/import_status.h"
  47 #include "ardour/tempo.h"
  48 #include "ardour/location.h"
  49 #include "ardour/types.h"
  50
  51 #include "canvas/fwd.h"
  52 #include "canvas/ruler.h"
  53
  54 #include "ardour_button.h"
  55 #include "ardour_dialog.h"
  56 #include "ardour_dropdown.h"
  57 #include "public_editor.h"
  58 #include "editing.h"
  59 #include "enums.h"
  60 #include "editor_items.h"
  61 #include "region_selection.h"
  62 #include "selection_memento.h"
  63
  64 namespace Gtkmm2ext {
  65         class Bindings;
  66 }
  67
  68 namespace ARDOUR {
  69         class AudioPlaylist;
  70         class AudioRegion;
  71         class AudioTrack;
  72         class ChanCount;
  73         class Filter;
  74         class Location;
  75         class MidiOperator;
  76         class MidiRegion;
  77         class MidiTrack;
  78         class Playlist;
  79         class Region;
  80         class RouteGroup;
  81         class Session;
  82         class TempoSection;
  83         class Track;
  84 }
  85
  86 namespace LADSPA {
  87         class Plugin;
  88 }
  89
  90 class AnalysisWindow;
  91 class AudioClock;
  92 class AudioRegionView;
  93 class AudioStreamView;
  94 class AudioTimeAxisView;
  95 class AutomationLine;
  96 class AutomationSelection;
  97 class AutomationTimeAxisView;
  98 class BundleManager;
  99 class ButtonJoiner;
 100 class ControlPoint;
 101 class CursorContext;
 102 class DragManager;
 103 class EditNoteDialog;
 104 class EditorCursor;
 105 class EditorGroupTabs;
 106 class EditorLocations;
 107 class EditorRegions;
 108 class EditorRoutes;
 109 class EditorRouteGroups;
 110 class EditorSnapshots;
 111 class EditorSummary;
 112 class GroupedButtons;
 113 class GUIObjectState;
 114 class ArdourMarker;
 115 class MidiRegionView;
 116 class MidiExportDialog;
 117 class MixerStrip;
 118 class MouseCursors;
 119 class NoteBase;
 120 class PlaylistSelector;
 121 class PluginSelector;
 122 class ProgressReporter;
 123 class QuantizeDialog;
 124 class RhythmFerret;
 125 class RulerDialog;
 126 class Selection;
 127 class SoundFileOmega;
 128 class StreamView;
 129 class TempoLines;
 130 class TimeAxisView;
 131 class TimeFXDialog;
 132 class TimeSelection;
 133 class RegionLayeringOrderEditor;
 134 class VerboseCursor;
 135
 136 class Editor : public PublicEditor, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr
 137 {
 138  public:
 139         Editor ();
 140         ~Editor ();
 141
 142         void             set_session (ARDOUR::Session *);
 143         ARDOUR::Session* session() const { return _session; }
 144
 145         Gtk::Window* use_own_window (bool and_fill_it);
 146
 147         void             first_idle ();
 148         virtual bool     have_idled () const { return _have_idled; }
 149
 150         framepos_t leftmost_sample() const { return leftmost_frame; }
 151
 152         framecnt_t current_page_samples() const {
 153                 return (framecnt_t) _visible_canvas_width * samples_per_pixel;
 154         }
 155
 156         double visible_canvas_height () const {
 157                 return _visible_canvas_height;
 158         }
 159         double trackviews_height () const;
 160
 161         void cycle_snap_mode ();
 162         void next_snap_choice ();
 163         void next_snap_choice_music_only ();
 164         void next_snap_choice_music_and_time ();
 165         void prev_snap_choice ();
 166         void prev_snap_choice_music_only ();
 167         void prev_snap_choice_music_and_time ();
 168         void set_snap_to (Editing::SnapType);
 169         void set_snap_mode (Editing::SnapMode);
 170         void set_snap_threshold (double pixel_distance) {snap_threshold = pixel_distance;}
 171
 172         Editing::SnapMode  snap_mode () const;
 173         Editing::SnapType  snap_type () const;
 174         bool  snap_musical () const;
 175
 176         void undo (uint32_t n = 1);
 177         void redo (uint32_t n = 1);
 178
 179         XMLNode& get_state ();
 180         int set_state (const XMLNode&, int version);
 181
 182         void set_mouse_mode (Editing::MouseMode, bool force=true);
 183         void step_mouse_mode (bool next);
 184         Editing::MouseMode current_mouse_mode () const { return mouse_mode; }
 185         Editing::MidiEditMode current_midi_edit_mode () const;
 186         void remove_midi_note (ArdourCanvas::Item *, GdkEvent *);
 187
 188         bool internal_editing() const;
 189
 190         void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>);
 191         void add_to_idle_resize (TimeAxisView*, int32_t);
 192
 193         RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const;
 194
 195         void consider_auditioning (boost::shared_ptr<ARDOUR::Region>);
 196         void hide_a_region (boost::shared_ptr<ARDOUR::Region>);
 197         void show_a_region (boost::shared_ptr<ARDOUR::Region>);
 198
 199 #ifdef USE_RUBBERBAND
 200         std::vector<std::string> rb_opt_strings;
 201         int rb_current_opt;
 202 #endif
 203
 204         /* things that need to be public to be used in the main menubar */
 205
 206         void new_region_from_selection ();
 207         void separate_regions_between (const TimeSelection&);
 208         void separate_region_from_selection ();
 209         void separate_under_selected_regions ();
 210         void separate_region_from_punch ();
 211         void separate_region_from_loop ();
 212         void separate_regions_using_location (ARDOUR::Location&);
 213         void transition_to_rolling (bool forward);
 214
 215         /* NOTE: these functions assume that the "pixel" coordinate is
 216            in canvas coordinates. These coordinates already take into
 217            account any scrolling offsets.
 218         */
 219
 220         framepos_t pixel_to_sample_from_event (double pixel) const {
 221
 222                 /* pixel can be less than zero when motion events
 223                    are processed. since we've already run the world->canvas
 224                    affine, that means that the location *really* is "off
 225                    to the right" and thus really is "before the start".
 226                 */
 227
 228                 if (pixel >= 0) {
 229                         return pixel * samples_per_pixel;
 230                 } else {
 231                         return 0;
 232                 }
 233         }
 234
 235         framepos_t pixel_to_sample (double pixel) const {
 236                 return pixel * samples_per_pixel;
 237         }
 238
 239         double sample_to_pixel (framepos_t sample) const {
 240                 return round (sample / (double) samples_per_pixel);
 241         }
 242
 243         double sample_to_pixel_unrounded (framepos_t sample) const {
 244                 return sample / (double) samples_per_pixel;
 245         }
 246
 247         /* selection */
 248
 249         Selection& get_selection() const { return *selection; }
 250         bool get_selection_extents (framepos_t &start, framepos_t &end) const;  // the time extents of the current selection, whether Range, Region(s), Control Points, or Notes
 251         Selection& get_cut_buffer() const { return *cut_buffer; }
 252         void track_mixer_selection ();
 253
 254         bool extend_selection_to_track (TimeAxisView&);
 255
 256         void play_selection ();
 257         framepos_t get_preroll ();
 258         void maybe_locate_with_edit_preroll (framepos_t);
 259         void play_with_preroll ();
 260         void select_all_in_track (Selection::Operation op);
 261         void select_all_objects (Selection::Operation op);
 262         void invert_selection_in_track ();
 263         void invert_selection ();
 264         void deselect_all ();
 265         long select_range (framepos_t, framepos_t);
 266
 267         void set_selected_regionview_from_region_list (boost::shared_ptr<ARDOUR::Region> region, Selection::Operation op = Selection::Set);
 268
 269         void remove_tracks ();
 270
 271         /* tempo */
 272
 273         void set_show_measures (bool yn);
 274         bool show_measures () const { return _show_measures; }
 275
 276         /* analysis window */
 277
 278         void loudness_analyze_region_selection();
 279         void loudness_analyze_range_selection();
 280
 281         void spectral_analyze_region_selection();
 282         void spectral_analyze_range_selection();
 283
 284         /* export */
 285
 286         void export_audio ();
 287         void stem_export ();
 288         void export_selection ();
 289         void export_range ();
 290         void export_region ();
 291
 292         bool process_midi_export_dialog (MidiExportDialog& dialog, boost::shared_ptr<ARDOUR::MidiRegion> midi_region);
 293
 294         void               set_zoom_focus (Editing::ZoomFocus);
 295         Editing::ZoomFocus get_zoom_focus () const { return zoom_focus; }
 296         framecnt_t         get_current_zoom () const { return samples_per_pixel; }
 297         void               cycle_zoom_focus ();
 298         void temporal_zoom_step (bool coarser);
 299         void temporal_zoom_step_mouse_focus (bool coarser);
 300         void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top);
 301         void tav_zoom_step (bool coarser);
 302         void tav_zoom_smooth (bool coarser, bool force_all);
 303
 304         /* stuff that AudioTimeAxisView and related classes use */
 305
 306         PlaylistSelector& playlist_selector() const;
 307         void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>);
 308
 309         void new_playlists (TimeAxisView* v);
 310         void copy_playlists (TimeAxisView* v);
 311         void clear_playlists (TimeAxisView* v);
 312
 313         void get_onscreen_tracks (TrackViewList&);
 314
 315         Width editor_mixer_strip_width;
 316         void maybe_add_mixer_strip_width (XMLNode&);
 317         void show_editor_mixer (bool yn);
 318         void create_editor_mixer ();
 319         void show_editor_list (bool yn);
 320         void set_selected_mixer_strip (TimeAxisView&);
 321         void mixer_strip_width_changed ();
 322         void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false);
 323
 324         /* nudge is initiated by transport controls owned by ARDOUR_UI */
 325
 326         framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next);
 327         framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration);
 328         unsigned get_grid_beat_divisions(framepos_t position);
 329         Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position);
 330
 331         void nudge_forward (bool next, bool force_playhead);
 332         void nudge_backward (bool next, bool force_playhead);
 333
 334         /* nudge initiated from context menu */
 335
 336         void nudge_forward_capture_offset ();
 337         void nudge_backward_capture_offset ();
 338
 339         void sequence_regions ();
 340
 341         /* playhead/screen stuff */
 342
 343         void set_stationary_playhead (bool yn);
 344         void toggle_stationary_playhead ();
 345         bool stationary_playhead() const { return _stationary_playhead; }
 346
 347         void set_follow_playhead (bool yn, bool catch_up = true);
 348         void toggle_follow_playhead ();
 349         bool follow_playhead() const { return _follow_playhead; }
 350         bool dragging_playhead () const { return _dragging_playhead; }
 351
 352         void toggle_zero_line_visibility ();
 353         void set_summary ();
 354         void set_group_tabs ();
 355         void toggle_measure_visibility ();
 356
 357         /* fades */
 358
 359         void toggle_region_fades (int dir);
 360         void update_region_fade_visibility ();
 361
 362         /* redirect shared ops menu. caller must free returned menu */
 363
 364         Gtk::Menu* redirect_menu ();
 365
 366         /* floating windows/transient */
 367
 368         void ensure_float (Gtk::Window&);
 369
 370         void scroll_tracks_down_line ();
 371         void scroll_tracks_up_line ();
 372
 373         bool scroll_up_one_track (bool skip_child_views = false);
 374         bool scroll_down_one_track (bool skip_child_views = false);
 375
 376         void scroll_left_step ();
 377         void scroll_right_step ();
 378
 379         void scroll_left_half_page ();
 380         void scroll_right_half_page ();
 381
 382         void prepare_for_cleanup ();
 383         void finish_cleanup ();
 384
 385         void maximise_editing_space();
 386         void restore_editing_space();
 387
 388         double get_y_origin () const;
 389         void reset_x_origin (framepos_t);
 390         void reset_x_origin_to_follow_playhead ();
 391         void reset_y_origin (double);
 392         void reset_zoom (framecnt_t);
 393         void reposition_and_zoom (framepos_t, double);
 394
 395         framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE,
 396                                                 bool use_context_click = false,
 397                                                 bool from_outside_canvas = false);
 398
 399         bool update_mouse_speed ();
 400         bool decelerate_mouse_speed ();
 401
 402         void toggle_meter_updating();
 403
 404         void show_rhythm_ferret();
 405
 406         void goto_visual_state (uint32_t);
 407         void save_visual_state (uint32_t);
 408
 409         void queue_draw_resize_line (int at);
 410         void start_resize_line_ops ();
 411         void end_resize_line_ops ();
 412
 413         TrackViewList const & get_track_views () {
 414                 return track_views;
 415         }
 416
 417         int get_regionview_count_from_region_list (boost::shared_ptr<ARDOUR::Region>);
 418
 419         void do_ptimport(std::string path, ARDOUR::SrcQuality quality);
 420
 421         void do_import (std::vector<std::string>              paths,
 422                         Editing::ImportDisposition            disposition,
 423                         Editing::ImportMode                   mode,
 424                         ARDOUR::SrcQuality                    quality,
 425                         framepos_t&                           pos,
 426                         boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
 427
 428         void do_embed (std::vector<std::string>              paths,
 429                        Editing::ImportDisposition            disposition,
 430                        Editing::ImportMode                   mode,
 431                        framepos_t&                           pos,
 432                        boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
 433
 434         void get_regions_corresponding_to (boost::shared_ptr<ARDOUR::Region> region, std::vector<RegionView*>& regions, bool src_comparison);
 435
 436         void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const;
 437         void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const;
 438
 439         void center_screen (framepos_t);
 440
 441         TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const;
 442
 443         void snap_to (framepos_t&       first,
 444                       ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
 445                       bool              for_mark  = false,
 446                       bool              ensure_snap = false);
 447
 448         void snap_to_with_modifier (framepos_t&       first,
 449                                     GdkEvent const *  ev,
 450                                     ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
 451                                     bool              for_mark  = false);
 452
 453         void snap_to (framepos_t&       first,
 454                       framepos_t&       last,
 455                       ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
 456                       bool              for_mark  = false);
 457
 458         void begin_selection_op_history ();
 459         void begin_reversible_selection_op (std::string cmd_name);
 460         void commit_reversible_selection_op ();
 461         void undo_selection_op ();
 462         void redo_selection_op ();
 463         void begin_reversible_command (std::string cmd_name);
 464         void begin_reversible_command (GQuark);
 465         void abort_reversible_command ();
 466         void commit_reversible_command ();
 467
 468         DragManager* drags () const {
 469                 return _drags;
 470         }
 471
 472         void maybe_autoscroll (bool, bool, bool);
 473         bool autoscroll_active() const;
 474
 475         Gdk::Cursor* get_canvas_cursor () const;
 476
 477         void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>);
 478         void set_current_movable (boost::shared_ptr<ARDOUR::Movable>);
 479
 480         MouseCursors const * cursors () const {
 481                 return _cursors;
 482         }
 483
 484         VerboseCursor* verbose_cursor () const {
 485                 return _verbose_cursor;
 486         }
 487
 488         double clamp_verbose_cursor_x (double);
 489         double clamp_verbose_cursor_y (double);
 490
 491         void get_pointer_position (double &, double &) const;
 492
 493         /** Context for mouse entry (stored in a stack). */
 494         struct EnterContext {
 495                 ItemType                         item_type;
 496                 boost::shared_ptr<CursorContext> cursor_ctx;
 497         };
 498
 499         /** Get the topmost enter context for the given item type.
 500          *
 501          * This is used to change the cursor associated with a given enter context,
 502          * which may not be on the top of the stack.
 503          */
 504         EnterContext* get_enter_context(ItemType type);
 505
 506         TimeAxisView* stepping_axis_view () {
 507                 return _stepping_axis_view;
 508         }
 509
 510         void set_stepping_axis_view (TimeAxisView* v) {
 511                 _stepping_axis_view = v;
 512         }
 513
 514         ArdourCanvas::Container* get_trackview_group () const { return _trackview_group; }
 515         ArdourCanvas::Container* get_noscroll_group () const { return no_scroll_group; }
 516         ArdourCanvas::ScrollGroup* get_hscroll_group () const { return h_scroll_group; }
 517         ArdourCanvas::ScrollGroup* get_hvscroll_group () const { return hv_scroll_group; }
 518         ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const { return cursor_scroll_group; }
 519
 520         ArdourCanvas::GtkCanvasViewport* get_track_canvas () const;
 521
 522         void override_visible_track_count ();
 523
 524         /* Ruler metrics methods */
 525
 526         void metric_get_timecode (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
 527         void metric_get_bbt (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
 528         void metric_get_samples (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
 529         void metric_get_minsec (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
 530
 531         /* editing operations that need to be public */
 532         void mouse_add_new_marker (framepos_t where, bool is_cd=false);
 533         void split_regions_at (framepos_t, RegionSelection&);
 534         void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false);
 535         RegionSelection get_regions_from_selection_and_mouse (framepos_t);
 536
 537         void mouse_add_new_tempo_event (framepos_t where);
 538         void mouse_add_new_meter_event (framepos_t where);
 539         void edit_tempo_section (ARDOUR::TempoSection*);
 540         void edit_meter_section (ARDOUR::MeterSection*);
 541
 542   protected:
 543         void map_transport_state ();
 544         void map_position_change (framepos_t);
 545
 546         void on_realize();
 547
 548         void suspend_route_redisplay ();
 549         void resume_route_redisplay ();
 550
 551   private:
 552
 553         void color_handler ();
 554
 555         bool                 constructed;
 556
 557         // to keep track of the playhead position for control_scroll
 558         boost::optional<framepos_t> _control_scroll_target;
 559
 560         PlaylistSelector* _playlist_selector;
 561
 562         typedef std::pair<TimeAxisView*,XMLNode*> TAVState;
 563
 564         struct VisualState {
 565             VisualState (bool with_tracks);
 566             ~VisualState ();
 567             double              y_position;
 568             framecnt_t          samples_per_pixel;
 569             framepos_t          leftmost_frame;
 570             Editing::ZoomFocus  zoom_focus;
 571             GUIObjectState*     gui_state;
 572         };
 573
 574         std::list<VisualState*> undo_visual_stack;
 575         std::list<VisualState*> redo_visual_stack;
 576         VisualState* current_visual_state (bool with_tracks = true);
 577         void undo_visual_state ();
 578         void redo_visual_state ();
 579         void use_visual_state (VisualState&);
 580         bool no_save_visual;
 581         void swap_visual_state ();
 582
 583         std::vector<VisualState*> visual_states;
 584         void start_visual_state_op (uint32_t n);
 585         void cancel_visual_state_op (uint32_t n);
 586
 587         framepos_t         leftmost_frame;
 588         framecnt_t         samples_per_pixel;
 589         Editing::ZoomFocus zoom_focus;
 590
 591         void set_samples_per_pixel (framecnt_t);
 592
 593         Editing::MouseMode mouse_mode;
 594         Editing::SnapType  pre_internal_snap_type;
 595         Editing::SnapMode  pre_internal_snap_mode;
 596         Editing::SnapType  internal_snap_type;
 597         Editing::SnapMode  internal_snap_mode;
 598         Editing::MouseMode effective_mouse_mode () const;
 599
 600         enum JoinObjectRangeState {
 601                 JOIN_OBJECT_RANGE_NONE,
 602                 /** `join object/range' mode is active and the mouse is over a place where object mode should happen */
 603                 JOIN_OBJECT_RANGE_OBJECT,
 604                 /** `join object/range' mode is active and the mouse is over a place where range mode should happen */
 605                 JOIN_OBJECT_RANGE_RANGE
 606         };
 607
 608         JoinObjectRangeState _join_object_range_state;
 609
 610         void update_join_object_range_location (double);
 611
 612         boost::optional<int>  pre_notebook_shrink_pane_width;
 613
 614         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
 615
 616         Gtk::Notebook _the_notebook;
 617         bool _notebook_shrunk;
 618         void add_notebook_page (std::string const &, Gtk::Widget &);
 619         bool notebook_tab_clicked (GdkEventButton *, Gtk::Widget *);
 620
 621         Gtk::HPaned   edit_pane;
 622         Gtk::VPaned   editor_summary_pane;
 623
 624         Gtk::EventBox meter_base;
 625         Gtk::HBox     meter_box;
 626         Gtk::EventBox marker_base;
 627         Gtk::HBox     marker_box;
 628         Gtk::VBox     scrollers_rulers_markers_box;
 629
 630         void location_changed (ARDOUR::Location *);
 631         void location_flags_changed (ARDOUR::Location *);
 632         void refresh_location_display ();
 633         void refresh_location_display_internal (const ARDOUR::Locations::LocationList&);
 634         void add_new_location (ARDOUR::Location *);
 635         ArdourCanvas::Container* add_new_location_internal (ARDOUR::Location *);
 636         void location_gone (ARDOUR::Location *);
 637         void remove_marker (ArdourCanvas::Item&, GdkEvent*);
 638         gint really_remove_marker (ARDOUR::Location* loc);
 639         void goto_nth_marker (int nth);
 640         void trigger_script (int nth);
 641         void toggle_marker_lines ();
 642         void set_marker_line_visibility (bool);
 643
 644         uint32_t location_marker_color;
 645         uint32_t location_range_color;
 646         uint32_t location_loop_color;
 647         uint32_t location_punch_color;
 648         uint32_t location_cd_marker_color;
 649
 650         struct LocationMarkers {
 651                 ArdourMarker* start;
 652                 ArdourMarker* end;
 653                 bool    valid;
 654
 655                 LocationMarkers () : start(0), end(0), valid (true) {}
 656
 657                 ~LocationMarkers ();
 658
 659                 void hide ();
 660                 void show ();
 661
 662                 void set_show_lines (bool);
 663                 void set_selected (bool);
 664                 void canvas_height_set (double);
 665                 void setup_lines ();
 666
 667                 void set_name (const std::string&);
 668                 void set_position (framepos_t start, framepos_t end = 0);
 669                 void set_color_rgba (uint32_t);
 670         };
 671
 672         LocationMarkers  *find_location_markers (ARDOUR::Location *) const;
 673         ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool& is_start) const;
 674         ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const;
 675         ArdourMarker* entered_marker;
 676         bool _show_marker_lines;
 677
 678         typedef std::map<ARDOUR::Location*,LocationMarkers *> LocationMarkerMap;
 679         LocationMarkerMap location_markers;
 680
 681         void update_marker_labels ();
 682         void update_marker_labels (ArdourCanvas::Container *);
 683         void check_marker_label (ArdourMarker *);
 684
 685         /** A set of lists of Markers that are in each of the canvas groups
 686          *  for the marker sections at the top of the editor.  These lists
 687          *  are kept sorted in time order between marker movements, so that after
 688          *  a marker has moved we can decide whether we need to update the labels
 689          *  for all markers or for just a few.
 690          */
 691         std::map<ArdourCanvas::Container *, std::list<ArdourMarker *> > _sorted_marker_lists;
 692         void remove_sorted_marker (ArdourMarker *);
 693
 694         void hide_marker (ArdourCanvas::Item*, GdkEvent*);
 695         void clear_marker_display ();
 696         void mouse_add_new_range (framepos_t);
 697         void mouse_add_new_loop (framepos_t);
 698         void mouse_add_new_punch (framepos_t);
 699         bool choose_new_marker_name(std::string &name);
 700         void update_cd_marker_display ();
 701         void ensure_cd_marker_updated (LocationMarkers * lam, ARDOUR::Location * location);
 702
 703         TimeAxisView*      clicked_axisview;
 704         RouteTimeAxisView* clicked_routeview;
 705         /** The last RegionView that was clicked on, or 0 if the last click was not
 706          * on a RegionView.  This is set up by the canvas event handlers in
 707          * editor_canvas_events.cc
 708          */
 709         RegionView*        clicked_regionview;
 710         RegionSelection    latest_regionviews;
 711         uint32_t           clicked_selection;
 712         ControlPoint*      clicked_control_point;
 713
 714         void sort_track_selection (TrackViewList&);
 715
 716         void get_equivalent_regions (RegionView* rv, std::vector<RegionView*> &, PBD::PropertyID) const;
 717         RegionSelection get_equivalent_regions (RegionSelection &, PBD::PropertyID) const;
 718         void mapover_tracks (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
 719         void mapover_tracks_with_unique_playlists (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
 720
 721         /* functions to be passed to mapover_tracks(), possibly with sigc::bind()-supplied arguments */
 722         void mapped_get_equivalent_regions (RouteTimeAxisView&, uint32_t, RegionView *, std::vector<RegionView*>*) const;
 723         void mapped_use_new_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
 724         void mapped_use_copy_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
 725         void mapped_clear_playlist (RouteTimeAxisView&, uint32_t);
 726
 727         void button_selection (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type);
 728         bool button_release_can_deselect;
 729         bool _mouse_changed_selection;
 730
 731         void catch_vanishing_regionview (RegionView *);
 732
 733         void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove=false);
 734         void select_all_tracks ();
 735         bool select_all_internal_edit (Selection::Operation);
 736
 737         bool set_selected_control_point_from_click (bool press, Selection::Operation op = Selection::Set);
 738         void set_selected_track_from_click (bool press, Selection::Operation op = Selection::Set, bool no_remove=false);
 739         void set_selected_track_as_side_effect (Selection::Operation op);
 740         bool set_selected_regionview_from_click (bool press, Selection::Operation op = Selection::Set);
 741
 742         bool set_selected_regionview_from_map_event (GdkEventAny*, StreamView*, boost::weak_ptr<ARDOUR::Region>);
 743         void collect_new_region_view (RegionView *);
 744         void collect_and_select_new_region_view (RegionView *);
 745
 746         Gtk::Menu track_context_menu;
 747         Gtk::Menu track_region_context_menu;
 748         Gtk::Menu track_selection_context_menu;
 749
 750         Gtk::MenuItem* region_edit_menu_split_item;
 751         Gtk::MenuItem* region_edit_menu_split_multichannel_item;
 752         Gtk::Menu * track_region_edit_playlist_menu;
 753         Gtk::Menu * track_edit_playlist_submenu;
 754         Gtk::Menu * track_selection_edit_playlist_submenu;
 755
 756         GdkEvent context_click_event;
 757
 758         void popup_track_context_menu (int, int, ItemType, bool);
 759         Gtk::Menu* build_track_context_menu ();
 760         Gtk::Menu* build_track_bus_context_menu ();
 761         Gtk::Menu* build_track_region_context_menu ();
 762         Gtk::Menu* build_track_selection_context_menu ();
 763         void add_dstream_context_items (Gtk::Menu_Helpers::MenuList&);
 764         void add_bus_context_items (Gtk::Menu_Helpers::MenuList&);
 765         void add_region_context_items (Gtk::Menu_Helpers::MenuList&, boost::shared_ptr<ARDOUR::Track>);
 766         void add_selection_context_items (Gtk::Menu_Helpers::MenuList&);
 767         Gtk::MenuItem* _popup_region_menu_item;
 768
 769         void popup_control_point_context_menu (ArdourCanvas::Item *, GdkEvent *);
 770         Gtk::Menu _control_point_context_menu;
 771
 772         void popup_note_context_menu (ArdourCanvas::Item *, GdkEvent *);
 773         Gtk::Menu _note_context_menu;
 774
 775         void add_routes (ARDOUR::RouteList&);
 776         void timeaxisview_deleted (TimeAxisView *);
 777
 778         Gtk::HBox global_hpacker;
 779         Gtk::VBox global_vpacker;
 780
 781         /* Cursor stuff.  Do not use directly, use via CursorContext. */
 782         friend class CursorContext;
 783         std::vector<Gdk::Cursor*> _cursor_stack;
 784         void set_canvas_cursor (Gdk::Cursor*);
 785         size_t push_canvas_cursor (Gdk::Cursor*);
 786         void pop_canvas_cursor ();
 787
 788         Gdk::Cursor* which_grabber_cursor () const;
 789         Gdk::Cursor* which_track_cursor () const;
 790         Gdk::Cursor* which_mode_cursor () const;
 791         Gdk::Cursor* which_trim_cursor (bool left_side) const;
 792         Gdk::Cursor* which_canvas_cursor (ItemType type) const;
 793
 794         /** Push the appropriate enter/cursor context on item entry. */
 795         void choose_canvas_cursor_on_entry (ItemType);
 796
 797         /** Update all enter cursors based on current settings. */
 798         void update_all_enter_cursors ();
 799
 800         ArdourCanvas::GtkCanvas* _track_canvas;
 801         ArdourCanvas::GtkCanvasViewport* _track_canvas_viewport;
 802
 803         bool within_track_canvas;
 804
 805         friend class VerboseCursor;
 806         VerboseCursor* _verbose_cursor;
 807
 808         void parameter_changed (std::string);
 809         void ui_parameter_changed (std::string);
 810
 811         Gtk::EventBox             time_bars_event_box;
 812         Gtk::VBox                 time_bars_vbox;
 813
 814         ArdourCanvas::Container      *tempo_group;
 815         ArdourCanvas::Container      *meter_group;
 816         ArdourCanvas::Container      *marker_group;
 817         ArdourCanvas::Container      *range_marker_group;
 818         ArdourCanvas::Container      *transport_marker_group;
 819         ArdourCanvas::Container*      cd_marker_group;
 820
 821         /* parent for groups which themselves contain time markers */
 822         ArdourCanvas::Container*     _time_markers_group;
 823
 824         /* The group containing all other groups that are scrolled vertically
 825            and horizontally.
 826         */
 827         ArdourCanvas::ScrollGroup* hv_scroll_group;
 828
 829         /* The group containing all other groups that are scrolled horizontally ONLY
 830         */
 831         ArdourCanvas::ScrollGroup* h_scroll_group;
 832
 833         /* Scroll group for cursors, scrolled horizontally, above everything else
 834         */
 835         ArdourCanvas::ScrollGroup* cursor_scroll_group;
 836
 837         /* The group containing all trackviews. */
 838         ArdourCanvas::Container* no_scroll_group;
 839
 840         /* The group containing all trackviews. */
 841         ArdourCanvas::Container* _trackview_group;
 842
 843         /* The group holding things (mostly regions) while dragging so they
 844          * are on top of everything else
 845          */
 846         ArdourCanvas::Container* _drag_motion_group;
 847
 848         /* a rect that sits at the bottom of all tracks to act as a drag-no-drop/clickable
 849          * target area.
 850          */
 851         ArdourCanvas::Rectangle* _canvas_drop_zone;
 852         bool canvas_drop_zone_event (GdkEvent* event);
 853
 854         enum RulerType {
 855                 ruler_metric_timecode = 0,
 856                 ruler_metric_bbt = 1,
 857                 ruler_metric_samples = 2,
 858                 ruler_metric_minsec = 3,
 859
 860                 ruler_time_tempo = 4,
 861                 ruler_time_meter = 5,
 862                 ruler_time_marker = 6,
 863                 ruler_time_range_marker = 7,
 864                 ruler_time_transport_marker = 8,
 865                 ruler_time_cd_marker = 9,
 866                 ruler_video_timeline = 10,
 867         };
 868
 869         Glib::RefPtr<Gtk::ToggleAction> ruler_timecode_action;
 870         Glib::RefPtr<Gtk::ToggleAction> ruler_bbt_action;
 871         Glib::RefPtr<Gtk::ToggleAction> ruler_samples_action;
 872         Glib::RefPtr<Gtk::ToggleAction> ruler_minsec_action;
 873         Glib::RefPtr<Gtk::ToggleAction> ruler_tempo_action;
 874         Glib::RefPtr<Gtk::ToggleAction> ruler_meter_action;
 875         Glib::RefPtr<Gtk::ToggleAction> ruler_marker_action;
 876         Glib::RefPtr<Gtk::ToggleAction> ruler_range_action;
 877         Glib::RefPtr<Gtk::ToggleAction> ruler_loop_punch_action;
 878         Glib::RefPtr<Gtk::ToggleAction> ruler_cd_marker_action;
 879         bool                            no_ruler_shown_update;
 880
 881         Gtk::Widget * ruler_grabbed_widget;
 882
 883         RulerDialog* ruler_dialog;
 884
 885         void initialize_rulers ();
 886         void update_just_timecode ();
 887         void compute_fixed_ruler_scale (); //calculates the RulerScale of the fixed rulers
 888         void update_fixed_rulers ();
 889         void update_tempo_based_rulers (std::vector<ARDOUR::TempoMap::BBTPoint>& grid);
 890         void popup_ruler_menu (framepos_t where = 0, ItemType type = RegionItem);
 891         void update_ruler_visibility ();
 892         void set_ruler_visible (RulerType, bool);
 893         void toggle_ruler_visibility (RulerType rt);
 894         void ruler_toggled (int);
 895         bool ruler_label_button_release (GdkEventButton*);
 896         void store_ruler_visibility ();
 897         void restore_ruler_visibility ();
 898
 899
 900
 901                 enum MinsecRulerScale {
 902                 minsec_show_msecs,
 903                 minsec_show_seconds,
 904                 minsec_show_minutes,
 905                 minsec_show_hours,
 906                 minsec_show_many_hours
 907         };
 908
 909         MinsecRulerScale minsec_ruler_scale;
 910
 911         framecnt_t minsec_mark_interval;
 912         gint minsec_mark_modulo;
 913         gint minsec_nmarks;
 914         void set_minsec_ruler_scale (framepos_t, framepos_t);
 915
 916         enum TimecodeRulerScale {
 917                 timecode_show_bits,
 918                 timecode_show_frames,
 919                 timecode_show_seconds,
 920                 timecode_show_minutes,
 921                 timecode_show_hours,
 922                 timecode_show_many_hours
 923         };
 924
 925         TimecodeRulerScale timecode_ruler_scale;
 926
 927         gint timecode_mark_modulo;
 928         gint timecode_nmarks;
 929         void set_timecode_ruler_scale (framepos_t, framepos_t);
 930
 931         framecnt_t _samples_ruler_interval;
 932         void set_samples_ruler_scale (framepos_t, framepos_t);
 933
 934         enum BBTRulerScale {
 935                 bbt_show_many,
 936                 bbt_show_64,
 937                 bbt_show_16,
 938                 bbt_show_4,
 939                 bbt_show_1,
 940                 bbt_show_beats,
 941                 bbt_show_ticks,
 942                 bbt_show_ticks_detail,
 943                 bbt_show_ticks_super_detail
 944         };
 945
 946         BBTRulerScale bbt_ruler_scale;
 947
 948         uint32_t bbt_bars;
 949         gint bbt_nmarks;
 950         uint32_t bbt_bar_helper_on;
 951         uint32_t bbt_accent_modulo;
 952         void compute_bbt_ruler_scale (std::vector<ARDOUR::TempoMap::BBTPoint>& grid, framepos_t lower, framepos_t upper);
 953
 954         ArdourCanvas::Ruler* timecode_ruler;
 955         ArdourCanvas::Ruler* bbt_ruler;
 956         ArdourCanvas::Ruler* samples_ruler;
 957         ArdourCanvas::Ruler* minsec_ruler;
 958
 959         static double timebar_height;
 960         guint32 visible_timebars;
 961         Gtk::Menu          *editor_ruler_menu;
 962
 963         ArdourCanvas::Rectangle* tempo_bar;
 964         ArdourCanvas::Rectangle* meter_bar;
 965         ArdourCanvas::Rectangle* marker_bar;
 966         ArdourCanvas::Rectangle* range_marker_bar;
 967         ArdourCanvas::Rectangle* transport_marker_bar;
 968         ArdourCanvas::Rectangle* cd_marker_bar;
 969
 970         Gtk::Label  minsec_label;
 971         Gtk::Label  bbt_label;
 972         Gtk::Label  timecode_label;
 973         Gtk::Label  samples_label;
 974         Gtk::Label  tempo_label;
 975         Gtk::Label  meter_label;
 976         Gtk::Label  mark_label;
 977         Gtk::Label  range_mark_label;
 978         Gtk::Label  transport_mark_label;
 979         Gtk::Label  cd_mark_label;
 980
 981         /* videtimline related actions */
 982         Gtk::Label                videotl_label;
 983         ArdourCanvas::Container*      videotl_group;
 984         Glib::RefPtr<Gtk::ToggleAction> ruler_video_action;
 985         Glib::RefPtr<Gtk::ToggleAction> xjadeo_proc_action;
 986         Glib::RefPtr<Gtk::ToggleAction> xjadeo_ontop_action;
 987         Glib::RefPtr<Gtk::ToggleAction> xjadeo_timecode_action;
 988         Glib::RefPtr<Gtk::ToggleAction> xjadeo_frame_action;
 989         Glib::RefPtr<Gtk::ToggleAction> xjadeo_osdbg_action;
 990         Glib::RefPtr<Gtk::ToggleAction> xjadeo_fullscreen_action;
 991         Glib::RefPtr<Gtk::ToggleAction> xjadeo_letterbox_action;
 992         Glib::RefPtr<Gtk::Action> xjadeo_zoom_100;
 993         void set_xjadeo_proc ();
 994         void toggle_xjadeo_proc (int state=-1);
 995         void set_close_video_sensitive (bool onoff);
 996         void set_xjadeo_sensitive (bool onoff);
 997         void set_xjadeo_viewoption (int);
 998         void toggle_xjadeo_viewoption (int what, int state=-1);
 999         void toggle_ruler_video (bool onoff) {ruler_video_action->set_active(onoff);}
1000         int videotl_bar_height; /* in units of timebar_height; default: 4 */
1001         int get_videotl_bar_height () const { return videotl_bar_height; }
1002         void toggle_region_video_lock ();
1003
1004         friend class EditorCursor;
1005
1006         EditorCursor*        playhead_cursor;
1007
1008         framepos_t get_region_boundary (framepos_t pos, int32_t dir, bool with_selection, bool only_onscreen);
1009
1010         void    cursor_to_region_boundary (bool with_selection, int32_t dir);
1011         void    cursor_to_next_region_boundary (bool with_selection);
1012         void    cursor_to_previous_region_boundary (bool with_selection);
1013         void    cursor_to_next_region_point (EditorCursor*, ARDOUR::RegionPoint);
1014         void    cursor_to_previous_region_point (EditorCursor*, ARDOUR::RegionPoint);
1015         void    cursor_to_region_point (EditorCursor*, ARDOUR::RegionPoint, int32_t dir);
1016         void    cursor_to_selection_start (EditorCursor *);
1017         void    cursor_to_selection_end   (EditorCursor *);
1018
1019         void    selected_marker_to_region_boundary (bool with_selection, int32_t dir);
1020         void    selected_marker_to_next_region_boundary (bool with_selection);
1021         void    selected_marker_to_previous_region_boundary (bool with_selection);
1022         void    selected_marker_to_next_region_point (ARDOUR::RegionPoint);
1023         void    selected_marker_to_previous_region_point (ARDOUR::RegionPoint);
1024         void    selected_marker_to_region_point (ARDOUR::RegionPoint, int32_t dir);
1025         void    selected_marker_to_selection_start ();
1026         void    selected_marker_to_selection_end   ();
1027
1028         void    select_all_selectables_using_cursor (EditorCursor *, bool);
1029         void    select_all_selectables_using_edit (bool, bool);
1030         void    select_all_selectables_between (bool within);
1031         void    select_range_between ();
1032
1033         boost::shared_ptr<ARDOUR::Region> find_next_region (ARDOUR::framepos_t, ARDOUR::RegionPoint, int32_t dir, TrackViewList&, TimeAxisView ** = 0);
1034         ARDOUR::framepos_t find_next_region_boundary (ARDOUR::framepos_t, int32_t dir, const TrackViewList&);
1035
1036         std::vector<ARDOUR::framepos_t> region_boundary_cache;
1037         void build_region_boundary_cache ();
1038
1039         Gtk::HBox           toplevel_hpacker;
1040
1041         Gtk::HBox           top_hbox;
1042         Gtk::HBox           bottom_hbox;
1043
1044         Gtk::Table          edit_packer;
1045
1046         /** the adjustment that controls the overall editor vertical scroll position */
1047         Gtk::Adjustment     vertical_adjustment;
1048         Gtk::Adjustment     horizontal_adjustment;
1049
1050         Gtk::Adjustment     unused_adjustment; // yes, really; Gtk::Layout constructor requires refs
1051         Gtk::Layout         controls_layout;
1052         bool control_layout_scroll (GdkEventScroll* ev);
1053         void reset_controls_layout_width ();
1054         void reset_controls_layout_height (int32_t height);
1055
1056         enum Direction {
1057                 LEFT,
1058                 RIGHT,
1059                 UP,
1060                 DOWN
1061         };
1062
1063         bool scroll_press (Direction);
1064         void scroll_release ();
1065         sigc::connection _scroll_connection;
1066         int _scroll_callbacks;
1067
1068         double _visible_canvas_width;
1069         double _visible_canvas_height; ///< height of the visible area of the track canvas
1070         double _full_canvas_height;    ///< full height of the canvas
1071
1072         bool track_canvas_map_handler (GdkEventAny*);
1073
1074         bool edit_controls_button_release (GdkEventButton*);
1075         Gtk::Menu *edit_controls_left_menu;
1076         Gtk::Menu *edit_controls_right_menu;
1077
1078         Gtk::VBox           track_canvas_vbox;
1079         Gtk::VBox           edit_controls_vbox;
1080         Gtk::HBox           edit_controls_hbox;
1081
1082         void control_vertical_zoom_in_all ();
1083         void control_vertical_zoom_out_all ();
1084         void control_vertical_zoom_in_selected ();
1085         void control_vertical_zoom_out_selected ();
1086         void control_step_tracks_up ();
1087         void control_step_tracks_down ();
1088         void control_view (uint32_t);
1089         void control_scroll (float);
1090         void control_select (uint32_t rid, Selection::Operation);
1091         void control_unselect ();
1092         void access_action (std::string,std::string);
1093         bool deferred_control_scroll (framepos_t);
1094         sigc::connection control_scroll_connection;
1095
1096         void tie_vertical_scrolling ();
1097         void set_horizontal_position (double);
1098         double horizontal_position () const;
1099
1100         struct VisualChange {
1101                 enum Type {
1102                         TimeOrigin = 0x1,
1103                         ZoomLevel = 0x2,
1104                         YOrigin = 0x4
1105                 };
1106
1107                 Type       pending;
1108                 framepos_t time_origin;
1109                 framecnt_t samples_per_pixel;
1110                 double     y_origin;
1111
1112                 int idle_handler_id;
1113                 /** true if we are currently in the idle handler */
1114                 bool being_handled;
1115
1116                 VisualChange() : pending ((VisualChange::Type) 0), time_origin (0), samples_per_pixel (0), idle_handler_id (-1), being_handled (false) {}
1117                 void add (Type t) {
1118                         pending = Type (pending | t);
1119                 }
1120         };
1121
1122         VisualChange pending_visual_change;
1123
1124         static int _idle_visual_changer (void *arg);
1125         int idle_visual_changer ();
1126         void visual_changer (const VisualChange&);
1127         void ensure_visual_change_idle_handler ();
1128
1129         /* track views */
1130         TrackViewList track_views;
1131         std::pair<TimeAxisView*, double> trackview_by_y_position (double, bool trackview_relative_offset = true) const;
1132         RouteTimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const;
1133
1134         TrackViewList get_tracks_for_range_action () const;
1135
1136         sigc::connection super_rapid_screen_update_connection;
1137         framepos_t last_update_frame;
1138         void center_screen_internal (framepos_t, float);
1139
1140         void super_rapid_screen_update ();
1141
1142         void session_going_away ();
1143
1144         framepos_t cut_buffer_start;
1145         framecnt_t cut_buffer_length;
1146
1147         boost::shared_ptr<CursorContext> _press_cursor_ctx;  ///< Button press cursor context
1148
1149         boost::weak_ptr<ARDOUR::Trimmable> _trimmable;
1150         boost::weak_ptr<ARDOUR::Movable> _movable;
1151
1152         bool typed_event (ArdourCanvas::Item*, GdkEvent*, ItemType);
1153         bool button_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1154         bool button_press_handler_1 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1155         bool button_press_handler_2 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1156         bool button_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1157         bool button_double_click_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1158         bool button_press_dispatch (GdkEventButton*);
1159         bool button_release_dispatch (GdkEventButton*);
1160         bool motion_handler (ArdourCanvas::Item*, GdkEvent*, bool from_autoscroll = false);
1161         bool enter_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1162         bool leave_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1163         bool key_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1164         bool key_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1165
1166         Gtkmm2ext::Bindings* button_bindings;
1167         XMLNode* button_settings () const;
1168
1169         /* KEYMAP HANDLING */
1170
1171         void register_actions ();
1172         void register_region_actions ();
1173
1174         void load_bindings ();
1175
1176         /* CUT/COPY/PASTE */
1177
1178         framepos_t last_paste_pos;
1179         unsigned   paste_count;
1180
1181         void cut_copy (Editing::CutCopyOp);
1182         bool can_cut_copy () const;
1183         void cut_copy_points (Editing::CutCopyOp, Evoral::Beats earliest=Evoral::Beats(), bool midi=false);
1184         void cut_copy_regions (Editing::CutCopyOp, RegionSelection&);
1185         void cut_copy_ranges (Editing::CutCopyOp);
1186         void cut_copy_midi (Editing::CutCopyOp);
1187
1188         void mouse_paste ();
1189         void paste_internal (framepos_t position, float times);
1190
1191         /* EDITING OPERATIONS */
1192
1193         void reset_point_selection ();
1194         void toggle_region_lock ();
1195         void toggle_opaque_region ();
1196         void toggle_record_enable ();
1197         void toggle_solo ();
1198         void toggle_solo_isolate ();
1199         void toggle_mute ();
1200         void toggle_region_lock_style ();
1201
1202         enum LayerOperation {
1203                 Raise,
1204                 RaiseToTop,
1205                 Lower,
1206                 LowerToBottom
1207         };
1208
1209         void do_layer_operation (LayerOperation);
1210         void raise_region ();
1211         void raise_region_to_top ();
1212         void change_region_layering_order (bool from_context_menu);
1213         void lower_region ();
1214         void lower_region_to_bottom ();
1215         void split_region_at_transients ();
1216         void crop_region_to_selection ();
1217         void crop_region_to (framepos_t start, framepos_t end);
1218         void set_sync_point (framepos_t, const RegionSelection&);
1219         void set_region_sync_position ();
1220         void remove_region_sync();
1221         void align_regions (ARDOUR::RegionPoint);
1222         void align_regions_relative (ARDOUR::RegionPoint point);
1223         void align_region (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1224         void align_region_internal (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1225         void remove_selected_regions ();
1226         void remove_clicked_region ();
1227         void show_region_properties ();
1228         void show_midi_list_editor ();
1229         void rename_region ();
1230         void duplicate_some_regions (RegionSelection&, float times);
1231         void duplicate_selection (float times);
1232         void region_fill_selection ();
1233         void combine_regions ();
1234         void uncombine_regions ();
1235
1236         void region_fill_track ();
1237         void audition_playlist_region_standalone (boost::shared_ptr<ARDOUR::Region>);
1238         void split_multichannel_region();
1239         void reverse_region ();
1240         void strip_region_silence ();
1241         void normalize_region ();
1242         void reset_region_scale_amplitude ();
1243         void adjust_region_gain (bool up);
1244         void quantize_region ();
1245         void quantize_regions (const RegionSelection& rs);
1246         void legatize_region (bool shrink_only);
1247         void legatize_regions (const RegionSelection& rs, bool shrink_only);
1248         void transform_region ();
1249         void transform_regions (const RegionSelection& rs);
1250         void transpose_region ();
1251         void transpose_regions (const RegionSelection& rs);
1252         void insert_patch_change (bool from_context);
1253         void fork_region ();
1254
1255         void do_insert_time ();
1256         void insert_time (framepos_t, framecnt_t, Editing::InsertTimeOption, bool, bool, bool, bool, bool, bool);
1257
1258         void do_remove_time ();
1259         void remove_time (framepos_t pos, framecnt_t distance, Editing::InsertTimeOption opt, bool ignore_music_glue, bool markers_too,
1260                         bool glued_markers_too, bool locked_markers_too, bool tempo_too);
1261
1262         void tab_to_transient (bool forward);
1263
1264         void set_tempo_from_region ();
1265         void use_range_as_bar ();
1266
1267         void define_one_bar (framepos_t start, framepos_t end);
1268
1269         void audition_region_from_region_list ();
1270         void hide_region_from_region_list ();
1271         void show_region_in_region_list ();
1272
1273         void naturalize_region ();
1274
1275         void reset_focus (Gtk::Widget*);
1276
1277         void split_region ();
1278
1279         void delete_ ();
1280         void cut ();
1281         void copy ();
1282         void paste (float times, bool from_context_menu = false);
1283
1284         void place_transient ();
1285         void remove_transient (ArdourCanvas::Item* item);
1286         void snap_regions_to_grid ();
1287         void close_region_gaps ();
1288
1289         void keyboard_paste ();
1290
1291         void region_from_selection ();
1292         void create_region_from_selection (std::vector<boost::shared_ptr<ARDOUR::Region> >&);
1293
1294         void play_from_start ();
1295         void play_from_edit_point ();
1296         void play_from_edit_point_and_return ();
1297         void play_selected_region ();
1298         void play_edit_range ();
1299         void play_location (ARDOUR::Location&);
1300         void loop_location (ARDOUR::Location&);
1301
1302         void calc_extra_zoom_edges(framepos_t &start, framepos_t &end);
1303         void temporal_zoom_selection (bool both_axes = false);
1304         void temporal_zoom_region (bool both_axes);
1305         void temporal_zoom_session ();
1306         void temporal_zoom (framecnt_t samples_per_pixel);
1307         void temporal_zoom_by_frame (framepos_t start, framepos_t end);
1308         void temporal_zoom_to_frame (bool coarser, framepos_t frame);
1309
1310         void insert_region_list_selection (float times);
1311
1312         /* PT import */
1313         void external_pt_dialog ();
1314         typedef struct ptflookup {
1315                 uint16_t index1;
1316                 uint16_t index2;
1317                 PBD::ID  id;
1318
1319                 bool operator ==(const struct ptflookup& other) {
1320                         return (this->index1 == other.index1);
1321                 }
1322         } ptflookup_t;
1323
1324         /* import & embed */
1325
1326         void add_external_audio_action (Editing::ImportMode);
1327         void external_audio_dialog ();
1328         void session_import_dialog ();
1329
1330         int  check_whether_and_how_to_import(std::string, bool all_or_nothing = true);
1331         bool check_multichannel_status (const std::vector<std::string>& paths);
1332
1333         SoundFileOmega* sfbrowser;
1334
1335         void bring_in_external_audio (Editing::ImportMode mode,  framepos_t& pos);
1336
1337         bool  idle_drop_paths  (std::vector<std::string> paths, framepos_t frame, double ypos, bool copy);
1338         void  drop_paths_part_two  (const std::vector<std::string>& paths, framepos_t frame, double ypos, bool copy);
1339
1340         int import_sndfiles (std::vector<std::string>              paths,
1341                              Editing::ImportDisposition            disposition,
1342                              Editing::ImportMode                   mode,
1343                              ARDOUR::SrcQuality                    quality,
1344                              framepos_t&                           pos,
1345                              int                                   target_regions,
1346                              int                                   target_tracks,
1347                              boost::shared_ptr<ARDOUR::Track>&     track,
1348                              bool                                  replace,
1349                              boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1350
1351         int embed_sndfiles (std::vector<std::string>              paths,
1352                             bool                                  multiple_files,
1353                             bool&                                 check_sample_rate,
1354                             Editing::ImportDisposition            disposition,
1355                             Editing::ImportMode                   mode,
1356                             framepos_t&                           pos,
1357                             int                                   target_regions,
1358                             int                                   target_tracks,
1359                             boost::shared_ptr<ARDOUR::Track>&     track,
1360                             boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1361
1362         int add_sources (std::vector<std::string>              paths,
1363                          ARDOUR::SourceList&                   sources,
1364                          framepos_t&                           pos,
1365                          Editing::ImportDisposition            disposition,
1366                          Editing::ImportMode                   mode,
1367                          int                                   target_regions,
1368                          int                                   target_tracks,
1369                          boost::shared_ptr<ARDOUR::Track>&     track,
1370                          bool                                  add_channel_suffix,
1371                          boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1372
1373         int finish_bringing_in_material (boost::shared_ptr<ARDOUR::Region>     region,
1374                                          uint32_t                              in_chans,
1375                                          uint32_t                              out_chans,
1376                                          framepos_t&                           pos,
1377                                          Editing::ImportMode                   mode,
1378                                          boost::shared_ptr<ARDOUR::Track>&     existing_track,
1379                                          const std::string&                    new_track_name,
1380                                          boost::shared_ptr<ARDOUR::PluginInfo> instrument);
1381
1382         boost::shared_ptr<ARDOUR::AudioTrack> get_nth_selected_audio_track (int nth) const;
1383         boost::shared_ptr<ARDOUR::MidiTrack> get_nth_selected_midi_track (int nth) const;
1384
1385         void toggle_midi_input_active (bool flip_others);
1386
1387         ARDOUR::InterThreadInfo* current_interthread_info;
1388
1389         AnalysisWindow* analysis_window;
1390
1391         /* import specific info */
1392
1393         struct EditorImportStatus : public ARDOUR::ImportStatus {
1394             Editing::ImportMode mode;
1395             framepos_t pos;
1396             int target_tracks;
1397             int target_regions;
1398             boost::shared_ptr<ARDOUR::Track> track;
1399             bool replace;
1400         };
1401
1402         EditorImportStatus import_status;
1403         static void *_import_thread (void *);
1404         void* import_thread ();
1405         void finish_import ();
1406
1407         /* to support this ... */
1408
1409         void import_audio (bool as_tracks);
1410         void do_import (std::vector<std::string> paths, bool split, bool as_tracks);
1411
1412         void move_to_start ();
1413         void move_to_end ();
1414         void center_playhead ();
1415         void center_edit_point ();
1416         void playhead_forward_to_grid ();
1417         void playhead_backward_to_grid ();
1418         void scroll_playhead (bool forward);
1419         void scroll_backward (float pages=0.8f);
1420         void scroll_forward (float pages=0.8f);
1421         void scroll_tracks_down ();
1422         void scroll_tracks_up ();
1423         void set_mark ();
1424         void clear_markers ();
1425         void clear_ranges ();
1426         void clear_locations ();
1427         void unhide_markers ();
1428         void unhide_ranges ();
1429         void jump_forward_to_mark ();
1430         void jump_backward_to_mark ();
1431         void cursor_align (bool playhead_to_edit);
1432         void toggle_skip_playback ();
1433
1434         void remove_last_capture ();
1435         void select_all_selectables_using_time_selection ();
1436         void select_all_selectables_using_loop();
1437         void select_all_selectables_using_punch();
1438         void set_selection_from_range (ARDOUR::Location&);
1439         void set_selection_from_punch ();
1440         void set_selection_from_loop ();
1441         void set_selection_from_region ();
1442
1443         void add_location_mark (framepos_t where);
1444         void add_location_from_region ();
1445         void add_locations_from_region ();
1446         void add_location_from_selection ();
1447         void set_loop_from_selection (bool play);
1448         void set_punch_from_selection ();
1449         void set_punch_from_region ();
1450
1451         void set_session_start_from_playhead ();
1452         void set_session_end_from_playhead ();
1453         void set_session_extents_from_selection ();
1454
1455         void set_loop_from_region (bool play);
1456
1457         void set_loop_range (framepos_t start, framepos_t end, std::string cmd);
1458         void set_punch_range (framepos_t start, framepos_t end, std::string cmd);
1459
1460         void add_location_from_playhead_cursor ();
1461         void remove_location_at_playhead_cursor ();
1462         bool select_new_marker;
1463
1464         void reverse_selection ();
1465         void edit_envelope ();
1466
1467         double last_scrub_x;
1468         int scrubbing_direction;
1469         int scrub_reversals;
1470         int scrub_reverse_distance;
1471         void scrub (framepos_t, double);
1472
1473         void set_punch_start_from_edit_point ();
1474         void set_punch_end_from_edit_point ();
1475         void set_loop_start_from_edit_point ();
1476         void set_loop_end_from_edit_point ();
1477
1478         void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE );
1479         void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE);
1480         bool have_pending_keyboard_selection;
1481         framepos_t pending_keyboard_selection_start;
1482
1483         void move_range_selection_start_or_end_to_region_boundary (bool, bool);
1484
1485         Editing::SnapType _snap_type;
1486         Editing::SnapMode _snap_mode;
1487
1488         /// Snap threshold in pixels
1489         double snap_threshold;
1490
1491         bool ignore_gui_changes;
1492
1493         DragManager* _drags;
1494
1495         void escape ();
1496         void lock ();
1497         void unlock ();
1498         Gtk::Dialog* lock_dialog;
1499
1500         struct timeval last_event_time;
1501         bool generic_event_handler (GdkEvent*);
1502         bool lock_timeout_callback ();
1503         void start_lock_event_timing ();
1504
1505         Gtk::Menu fade_context_menu;
1506
1507         Gtk::Menu xfade_in_context_menu;
1508         Gtk::Menu xfade_out_context_menu;
1509         void popup_xfade_in_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1510         void popup_xfade_out_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1511         void fill_xfade_menu (Gtk::Menu_Helpers::MenuList& items, bool start);
1512
1513         void set_fade_in_shape (ARDOUR::FadeShape);
1514         void set_fade_out_shape (ARDOUR::FadeShape);
1515
1516         void set_fade_length (bool in);
1517         void set_fade_in_active (bool);
1518         void set_fade_out_active (bool);
1519
1520         void fade_range ();
1521
1522         std::set<boost::shared_ptr<ARDOUR::Playlist> > motion_frozen_playlists;
1523
1524         bool _dragging_playhead;
1525         bool _dragging_edit_point;
1526
1527         void marker_drag_motion_callback (GdkEvent*);
1528         void marker_drag_finished_callback (GdkEvent*);
1529
1530         gint mouse_rename_region (ArdourCanvas::Item*, GdkEvent*);
1531
1532         void add_region_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1533         void start_create_region_grab (ArdourCanvas::Item*, GdkEvent*);
1534         void add_region_copy_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1535         void add_region_brush_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1536         void start_selection_grab (ArdourCanvas::Item*, GdkEvent*);
1537
1538         void region_view_item_click (AudioRegionView&, GdkEventButton*);
1539
1540         bool can_remove_control_point (ArdourCanvas::Item *);
1541         void remove_control_point (ArdourCanvas::Item *);
1542
1543         void mouse_brush_insert_region (RegionView*, framepos_t pos);
1544
1545         /* Canvas event handlers */
1546
1547         bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas);
1548         bool canvas_control_point_event (GdkEvent* event,ArdourCanvas::Item*, ControlPoint*);
1549         bool canvas_line_event (GdkEvent* event,ArdourCanvas::Item*, AutomationLine*);
1550         bool canvas_selection_rect_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1551         bool canvas_selection_start_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1552         bool canvas_selection_end_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1553         bool canvas_start_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1554         bool canvas_end_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1555         bool canvas_fade_in_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1556         bool canvas_fade_in_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*, bool trim = false);
1557         bool canvas_fade_out_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1558         bool canvas_fade_out_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*, bool trim = false);
1559         bool canvas_region_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1560         bool canvas_wave_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1561         bool canvas_frame_handle_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1562         bool canvas_region_view_name_highlight_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1563         bool canvas_region_view_name_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1564         bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*);
1565         bool canvas_stream_view_event (GdkEvent* event,ArdourCanvas::Item*, RouteTimeAxisView*);
1566         bool canvas_marker_event (GdkEvent* event,ArdourCanvas::Item*, ArdourMarker*);
1567         bool canvas_tempo_marker_event (GdkEvent* event,ArdourCanvas::Item*, TempoMarker*);
1568         bool canvas_meter_marker_event (GdkEvent* event,ArdourCanvas::Item*, MeterMarker*);
1569         bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*);
1570         bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item *);
1571
1572         bool canvas_ruler_event (GdkEvent* event, ArdourCanvas::Item *, ItemType);
1573         bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1574         bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1575         bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1576         bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1577         bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1578         bool canvas_cd_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1579
1580         bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1581         void update_video_timeline (bool flush = false);
1582         void set_video_timeline_height (const int);
1583         bool is_video_timeline_locked ();
1584         void toggle_video_timeline_locked ();
1585         void set_video_timeline_locked (const bool);
1586         void queue_visual_videotimeline_update ();
1587         void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true);
1588
1589         PBD::Signal0<void> EditorFreeze;
1590         PBD::Signal0<void> EditorThaw;
1591
1592   private:
1593         friend class DragManager;
1594         friend class EditorRouteGroups;
1595         friend class EditorRegions;
1596
1597         /* non-public event handlers */
1598
1599         bool canvas_playhead_cursor_event (GdkEvent* event, ArdourCanvas::Item*);
1600         bool track_canvas_scroll (GdkEventScroll* event);
1601
1602         bool track_canvas_button_press_event (GdkEventButton* event);
1603         bool track_canvas_button_release_event (GdkEventButton* event);
1604         bool track_canvas_motion_notify_event (GdkEventMotion* event);
1605
1606         Gtk::Allocation _canvas_viewport_allocation;
1607         void track_canvas_viewport_allocate (Gtk::Allocation alloc);
1608         void track_canvas_viewport_size_allocated ();
1609         bool track_canvas_drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int, int, guint);
1610         bool track_canvas_key_press (GdkEventKey *);
1611         bool track_canvas_key_release (GdkEventKey *);
1612
1613         void set_playhead_cursor ();
1614
1615         void toggle_region_mute ();
1616
1617         void initialize_canvas ();
1618
1619         void set_script_action_name (int i, const std::string&);
1620
1621         /* display control */
1622
1623         bool _show_measures;
1624         /// true if the editor should follow the playhead, otherwise false
1625         bool _follow_playhead;
1626         /// true if we scroll the tracks rather than the playhead
1627         bool _stationary_playhead;
1628         /// true if we are in fullscreen mode
1629         bool _maximised;
1630
1631         TempoLines* tempo_lines;
1632
1633         ArdourCanvas::Container* global_rect_group;
1634         ArdourCanvas::Container* time_line_group;
1635
1636         void hide_measures ();
1637         void draw_measures (std::vector<ARDOUR::TempoMap::BBTPoint>&);
1638
1639         void new_tempo_section ();
1640
1641
1642         void remove_tempo_marker (ArdourCanvas::Item*);
1643         void remove_meter_marker (ArdourCanvas::Item*);
1644         gint real_remove_tempo_marker (ARDOUR::TempoSection*);
1645         gint real_remove_meter_marker (ARDOUR::MeterSection*);
1646
1647         void edit_tempo_marker (TempoMarker&);
1648         void edit_meter_marker (MeterMarker&);
1649         void edit_control_point (ArdourCanvas::Item*);
1650         void edit_notes (MidiRegionView*);
1651
1652         void marker_menu_edit ();
1653         void marker_menu_remove ();
1654         void marker_menu_rename ();
1655         void rename_marker (ArdourMarker *marker);
1656         void toggle_marker_lock_style ();
1657         void toggle_tempo_type ();
1658         void toggle_marker_menu_lock ();
1659         void toggle_marker_menu_glue ();
1660         void marker_menu_hide ();
1661         void marker_menu_loop_range ();
1662         void marker_menu_select_all_selectables_using_range ();
1663         void marker_menu_select_using_range ();
1664         void marker_menu_separate_regions_using_location ();
1665         void marker_menu_play_from ();
1666         void marker_menu_play_range ();
1667         void marker_menu_set_playhead ();
1668         void marker_menu_set_from_playhead ();
1669         void marker_menu_set_from_selection (bool force_regions);
1670         void marker_menu_range_to_next ();
1671         void marker_menu_zoom_to_range ();
1672         void new_transport_marker_menu_set_loop ();
1673         void new_transport_marker_menu_set_punch ();
1674         void update_loop_range_view ();
1675         void update_punch_range_view ();
1676         void new_transport_marker_menu_popdown ();
1677         void marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1678         void tempo_or_meter_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1679         void new_transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1680         void build_range_marker_menu (bool, bool);
1681         void build_marker_menu (ARDOUR::Location *);
1682         void build_tempo_marker_menu (TempoMarker *, bool);
1683         void build_meter_marker_menu (MeterMarker *, bool);
1684         void build_new_transport_marker_menu ();
1685         void dynamic_cast_marker_object (void*, MeterMarker**, TempoMarker**) const;
1686
1687         Gtk::Menu* tempo_marker_menu;
1688         Gtk::Menu* meter_marker_menu;
1689         Gtk::Menu* marker_menu;
1690         Gtk::Menu* range_marker_menu;
1691         Gtk::Menu* transport_marker_menu;
1692         Gtk::Menu* new_transport_marker_menu;
1693         Gtk::Menu* cd_marker_menu;
1694         ArdourCanvas::Item* marker_menu_item;
1695
1696         typedef std::list<ArdourMarker*> Marks;
1697         Marks metric_marks;
1698
1699         void remove_metric_marks ();
1700         void draw_metric_marks (const ARDOUR::Metrics& metrics);
1701
1702         void compute_current_bbt_points (std::vector<ARDOUR::TempoMap::BBTPoint>& grid, framepos_t left, framepos_t right);
1703
1704         void tempo_map_changed (const PBD::PropertyChange&);
1705         void marker_position_changed ();
1706         void redisplay_tempo (bool immediate_redraw);
1707
1708         uint32_t bbt_beat_subdivision;
1709
1710         /* toolbar */
1711
1712         Gtk::ToggleButton editor_mixer_button;
1713         Gtk::ToggleButton editor_list_button;
1714         void editor_mixer_button_toggled ();
1715         void editor_list_button_toggled ();
1716
1717         ArdourButton              zoom_in_button;
1718         ArdourButton              zoom_out_button;
1719         ArdourButton              zoom_out_full_button;
1720
1721         ArdourButton              tav_expand_button;
1722         ArdourButton              tav_shrink_button;
1723         ArdourDropdown            visible_tracks_selector;
1724         ArdourDropdown            zoom_preset_selector;
1725
1726         int32_t                   _visible_track_count;
1727         void build_track_count_menu ();
1728         void set_visible_track_count (int32_t);
1729
1730         void set_zoom_preset(int64_t);
1731
1732         Gtk::VBox                toolbar_clock_vbox;
1733         Gtk::VBox                toolbar_selection_clock_vbox;
1734         Gtk::Table               toolbar_selection_clock_table;
1735         Gtk::Label               toolbar_selection_cursor_label;
1736
1737         ArdourButton mouse_select_button;
1738         ArdourButton mouse_draw_button;
1739         ArdourButton mouse_move_button;
1740         ArdourButton mouse_timefx_button;
1741         ArdourButton mouse_content_button;
1742         ArdourButton mouse_audition_button;
1743         ArdourButton mouse_cut_button;
1744
1745         ArdourButton smart_mode_button;
1746         Glib::RefPtr<Gtk::ToggleAction> smart_mode_action;
1747
1748         void                     mouse_mode_toggled (Editing::MouseMode m);
1749         void                     mouse_mode_object_range_toggled ();
1750         bool                     ignore_mouse_mode_toggle;
1751
1752         bool                     mouse_select_button_release (GdkEventButton*);
1753
1754         Gtk::VBox                automation_box;
1755         Gtk::Button              automation_mode_button;
1756
1757         //edit mode menu stuff
1758         ArdourDropdown  edit_mode_selector;
1759         void edit_mode_selection_done ( ARDOUR::EditMode m );
1760         void build_edit_mode_menu ();
1761         Gtk::VBox         edit_mode_box;
1762
1763         void set_edit_mode (ARDOUR::EditMode);
1764         void cycle_edit_mode ();
1765
1766         ArdourDropdown snap_type_selector;
1767         void build_snap_type_menu ();
1768
1769         ArdourDropdown snap_mode_selector;
1770         void build_snap_mode_menu ();
1771         Gtk::HBox         snap_box;
1772
1773         std::vector<std::string> snap_type_strings;
1774         std::vector<std::string> snap_mode_strings;
1775
1776         void snap_type_selection_done (Editing::SnapType);
1777         void snap_mode_selection_done (Editing::SnapMode);
1778         void snap_mode_chosen (Editing::SnapMode);
1779         void snap_type_chosen (Editing::SnapType);
1780
1781         Glib::RefPtr<Gtk::RadioAction> snap_type_action (Editing::SnapType);
1782         Glib::RefPtr<Gtk::RadioAction> snap_mode_action (Editing::SnapMode);
1783
1784         //zoom focus meu stuff
1785         ArdourDropdown  zoom_focus_selector;
1786         void zoom_focus_selection_done ( Editing::ZoomFocus f );
1787         void build_zoom_focus_menu ();
1788         std::vector<std::string> zoom_focus_strings;
1789
1790         void zoom_focus_chosen (Editing::ZoomFocus);
1791
1792         Glib::RefPtr<Gtk::RadioAction> zoom_focus_action (Editing::ZoomFocus);
1793
1794         Gtk::HBox           _zoom_box;
1795         void                zoom_adjustment_changed();
1796
1797         void setup_toolbar ();
1798
1799         void setup_tooltips ();
1800
1801         Gtk::HBox                toolbar_hbox;
1802         Gtk::EventBox            toolbar_base;
1803         Gtk::Frame               toolbar_frame;
1804         Gtk::Viewport           _toolbar_viewport;
1805
1806         void setup_midi_toolbar ();
1807
1808         /* selection process */
1809
1810         Selection* selection;
1811         Selection* cut_buffer;
1812         SelectionMemento* _selection_memento;
1813
1814         void time_selection_changed ();
1815         void update_time_selection_display ();
1816         void track_selection_changed ();
1817         void region_selection_changed ();
1818         sigc::connection editor_regions_selection_changed_connection;
1819         void sensitize_all_region_actions (bool);
1820         void sensitize_the_right_region_actions ();
1821         bool _all_region_actions_sensitized;
1822         /** Flag to block region action handlers from doing what they normally do;
1823          *  I tried Gtk::Action::block_activate() but this doesn't work (ie it doesn't
1824          *  block) when setting a ToggleAction's active state.
1825          */
1826         bool _ignore_region_action;
1827         bool _last_region_menu_was_main;
1828         void point_selection_changed ();
1829         void marker_selection_changed ();
1830
1831         bool _ignore_follow_edits;
1832
1833         void cancel_selection ();
1834         void cancel_time_selection ();
1835
1836         bool get_smart_mode() const;
1837
1838         bool audio_region_selection_covers (framepos_t where);
1839
1840         /* transport range select process */
1841
1842         ArdourCanvas::Rectangle*  cd_marker_bar_drag_rect;
1843         ArdourCanvas::Rectangle*  range_bar_drag_rect;
1844         ArdourCanvas::Rectangle*  transport_bar_drag_rect;
1845         ArdourCanvas::Rectangle     *transport_bar_range_rect;
1846         ArdourCanvas::Rectangle     *transport_bar_preroll_rect;
1847         ArdourCanvas::Rectangle     *transport_bar_postroll_rect;
1848         ArdourCanvas::Rectangle     *transport_loop_range_rect;
1849         ArdourCanvas::Rectangle     *transport_punch_range_rect;
1850         ArdourCanvas::Line     *transport_punchin_line;
1851         ArdourCanvas::Line     *transport_punchout_line;
1852         ArdourCanvas::Rectangle     *transport_preroll_rect;
1853         ArdourCanvas::Rectangle     *transport_postroll_rect;
1854
1855         ARDOUR::Location*  transport_loop_location();
1856         ARDOUR::Location*  transport_punch_location();
1857
1858         ARDOUR::Location   *temp_location;
1859
1860         /* object rubberband select process */
1861
1862         void select_all_within (framepos_t, framepos_t, double, double, TrackViewList const &, Selection::Operation, bool);
1863
1864         ArdourCanvas::Rectangle   *rubberband_rect;
1865
1866         EditorRouteGroups* _route_groups;
1867         EditorRoutes* _routes;
1868         EditorRegions* _regions;
1869         EditorSnapshots* _snapshots;
1870         EditorLocations* _locations;
1871
1872         /* diskstream/route display management */
1873         Glib::RefPtr<Gdk::Pixbuf> rec_enabled_icon;
1874         Glib::RefPtr<Gdk::Pixbuf> rec_disabled_icon;
1875
1876         Glib::RefPtr<Gtk::TreeSelection> route_display_selection;
1877
1878         bool sync_track_view_list_and_routes ();
1879
1880         Gtk::VBox           list_vpacker;
1881
1882         /* autoscrolling */
1883
1884         sigc::connection autoscroll_connection;
1885         bool autoscroll_horizontal_allowed;
1886         bool autoscroll_vertical_allowed;
1887         uint32_t autoscroll_cnt;
1888         Gtk::Widget* autoscroll_widget;
1889         ArdourCanvas::Rect autoscroll_boundary;
1890
1891         bool autoscroll_canvas ();
1892         void start_canvas_autoscroll (bool allow_horiz, bool allow_vert, const ArdourCanvas::Rect& boundary);
1893         void stop_canvas_autoscroll ();
1894
1895         /* trimming */
1896         void point_trim (GdkEvent *, framepos_t);
1897
1898         void trim_region_front();
1899         void trim_region_back();
1900         void trim_region (bool front);
1901
1902         void trim_region_to_loop ();
1903         void trim_region_to_punch ();
1904         void trim_region_to_location (const ARDOUR::Location&, const char* cmd);
1905
1906         void trim_to_region(bool forward);
1907         void trim_region_to_previous_region_end();
1908         void trim_region_to_next_region_start();
1909
1910         bool show_gain_after_trim;
1911
1912         /* Drag-n-Drop */
1913
1914         int convert_drop_to_paths (
1915                 std::vector<std::string>&           paths,
1916                 const Glib::RefPtr<Gdk::DragContext>& context,
1917                 gint                                  x,
1918                 gint                                  y,
1919                 const Gtk::SelectionData&             data,
1920                 guint                                 info,
1921                 guint                                 time);
1922
1923         void track_canvas_drag_data_received (
1924                 const Glib::RefPtr<Gdk::DragContext>& context,
1925                 gint                                  x,
1926                 gint                                  y,
1927                 const Gtk::SelectionData&             data,
1928                 guint                                 info,
1929                 guint                                 time);
1930
1931         void drop_paths (
1932                 const Glib::RefPtr<Gdk::DragContext>& context,
1933                 gint                                  x,
1934                 gint                                  y,
1935                 const Gtk::SelectionData&             data,
1936                 guint                                 info,
1937                 guint                                 time);
1938
1939         void drop_regions (
1940                 const Glib::RefPtr<Gdk::DragContext>& context,
1941                 gint                                  x,
1942                 gint                                  y,
1943                 const Gtk::SelectionData&             data,
1944                 guint                                 info,
1945                 guint                                 time);
1946
1947         void drop_routes (
1948                 const Glib::RefPtr<Gdk::DragContext>& context,
1949                 gint                x,
1950                 gint                y,
1951                 const Gtk::SelectionData& data,
1952                 guint               info,
1953                 guint               time);
1954
1955         /* audio export */
1956
1957         int  write_region_selection(RegionSelection&);
1958         bool write_region (std::string path, boost::shared_ptr<ARDOUR::AudioRegion>);
1959         void bounce_region_selection (bool with_processing);
1960         void bounce_range_selection (bool replace, bool enable_processing);
1961         void external_edit_region ();
1962
1963         int write_audio_selection (TimeSelection&);
1964         bool write_audio_range (ARDOUR::AudioPlaylist&, const ARDOUR::ChanCount& channels, std::list<ARDOUR::AudioRange>&);
1965
1966         void write_selection ();
1967
1968         uint32_t selection_op_cmd_depth;
1969         uint32_t selection_op_history_it;
1970
1971         std::list<XMLNode *> selection_op_history; /* used in *_reversible_selection_op */
1972         std::list<XMLNode *> before; /* used in *_reversible_command */
1973
1974         void update_title ();
1975         void update_title_s (const std::string & snapshot_name);
1976
1977         void instant_save ();
1978         bool no_save_instant;
1979
1980         boost::shared_ptr<ARDOUR::AudioRegion> last_audition_region;
1981
1982         /* freeze operations */
1983
1984         ARDOUR::InterThreadInfo freeze_status;
1985         static void* _freeze_thread (void*);
1986         void* freeze_thread ();
1987
1988         void freeze_route ();
1989         void unfreeze_route ();
1990
1991         /* duplication */
1992
1993         void duplicate_range (bool with_dialog);
1994
1995         /** computes the timeline frame (sample) of an event whose coordinates
1996          * are in canvas units (pixels, scroll offset included).
1997          */
1998         framepos_t canvas_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
1999
2000         /** computes the timeline frame (sample) of an event whose coordinates
2001          * are in window units (pixels, no scroll offset).
2002          */
2003         framepos_t window_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
2004
2005         /* returns false if mouse pointer is not in track or marker canvas
2006          */
2007         bool mouse_frame (framepos_t&, bool& in_track_canvas) const;
2008
2009         TimeFXDialog* current_timefx;
2010         static void* timefx_thread (void *arg);
2011         void do_timefx ();
2012
2013         int time_stretch (RegionSelection&, float fraction);
2014         int pitch_shift (RegionSelection&, float cents);
2015         void pitch_shift_region ();
2016
2017         /* editor-mixer strip */
2018
2019         MixerStrip *current_mixer_strip;
2020         bool show_editor_mixer_when_tracks_arrive;
2021         Gtk::VBox current_mixer_strip_vbox;
2022         void cms_new (boost::shared_ptr<ARDOUR::Route>);
2023         void current_mixer_strip_hidden ();
2024
2025 #ifdef __APPLE__
2026         void ensure_all_elements_drawn ();
2027 #endif
2028         /* nudging tracks */
2029
2030         void nudge_track (bool use_edit_point, bool forwards);
2031
2032         static const int32_t default_width = 995;
2033         static const int32_t default_height = 765;
2034
2035         /* nudge */
2036
2037         ArdourButton      nudge_forward_button;
2038         ArdourButton      nudge_backward_button;
2039         Gtk::HBox        nudge_hbox;
2040         Gtk::VBox        nudge_vbox;
2041         AudioClock*       nudge_clock;
2042
2043         bool nudge_forward_release (GdkEventButton*);
2044         bool nudge_backward_release (GdkEventButton*);
2045
2046         /* audio filters */
2047
2048         void apply_filter (ARDOUR::Filter&, std::string cmd, ProgressReporter* progress = 0);
2049
2050         Command* apply_midi_note_edit_op_to_region (ARDOUR::MidiOperator& op, MidiRegionView& mrv);
2051         void apply_midi_note_edit_op (ARDOUR::MidiOperator& op, const RegionSelection& rs);
2052
2053         /* handling cleanup */
2054
2055         int playlist_deletion_dialog (boost::shared_ptr<ARDOUR::Playlist>);
2056
2057         PBD::ScopedConnectionList session_connections;
2058
2059         /* tracking step changes of track height */
2060
2061         TimeAxisView* current_stepping_trackview;
2062         ARDOUR::microseconds_t last_track_height_step_timestamp;
2063         gint track_height_step_timeout();
2064         sigc::connection step_timeout;
2065
2066         TimeAxisView* entered_track;
2067         /** If the mouse is over a RegionView or one of its child canvas items, this is set up
2068             to point to the RegionView.  Otherwise it is 0.
2069         */
2070         RegionView*   entered_regionview;
2071
2072         std::vector<EnterContext> _enter_stack;
2073
2074         bool clear_entered_track;
2075         bool left_track_canvas (GdkEventCrossing*);
2076         bool entered_track_canvas (GdkEventCrossing*);
2077         void set_entered_track (TimeAxisView*);
2078         void set_entered_regionview (RegionView*);
2079         gint left_automation_track ();
2080
2081         void reset_canvas_action_sensitivity (bool);
2082         void set_gain_envelope_visibility ();
2083         void set_region_gain_visibility (RegionView*);
2084         void toggle_gain_envelope_active ();
2085         void reset_region_gain_envelopes ();
2086
2087         void session_state_saved (std::string);
2088
2089         Glib::RefPtr<Gtk::Action>              undo_action;
2090         Glib::RefPtr<Gtk::Action>              redo_action;
2091         Glib::RefPtr<Gtk::Action>              alternate_redo_action;
2092         Glib::RefPtr<Gtk::Action>              alternate_alternate_redo_action;
2093         Glib::RefPtr<Gtk::Action>              selection_undo_action;
2094         Glib::RefPtr<Gtk::Action>              selection_redo_action;
2095
2096         void history_changed ();
2097
2098         Editing::EditPoint _edit_point;
2099
2100         ArdourDropdown edit_point_selector;
2101         void build_edit_point_menu();
2102
2103         void set_edit_point_preference (Editing::EditPoint ep, bool force = false);
2104         void cycle_edit_point (bool with_marker);
2105         void set_edit_point ();
2106         void edit_point_selection_done (Editing::EditPoint);
2107         void edit_point_chosen (Editing::EditPoint);
2108         Glib::RefPtr<Gtk::RadioAction> edit_point_action (Editing::EditPoint);
2109         std::vector<std::string> edit_point_strings;
2110         std::vector<std::string> edit_mode_strings;
2111
2112         void selected_marker_moved (ARDOUR::Location*);
2113
2114         bool get_edit_op_range (framepos_t& start, framepos_t& end) const;
2115
2116         void get_regions_at (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2117         void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2118
2119         RegionSelection get_regions_from_selection_and_edit_point ();
2120         RegionSelection get_regions_from_selection_and_entered () const;
2121
2122         void start_updating_meters ();
2123         void stop_updating_meters ();
2124         bool meters_running;
2125
2126         void select_next_route ();
2127         void select_prev_route ();
2128
2129         void snap_to_internal (framepos_t&       first,
2130                                ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
2131                                bool              for_mark  = false,
2132                                bool              ensure_snap = false);
2133
2134         void timecode_snap_to_internal (framepos_t&       first,
2135                                         ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
2136                                         bool              for_mark  = false);
2137
2138         RhythmFerret* rhythm_ferret;
2139
2140         void fit_tracks (TrackViewList &);
2141         void fit_selection ();
2142         void set_track_height (Height);
2143
2144         void _remove_tracks ();
2145         bool idle_remove_tracks ();
2146         void toggle_tracks_active ();
2147
2148         bool _have_idled;
2149         int resize_idle_id;
2150         static gboolean _idle_resize (gpointer);
2151         bool idle_resize();
2152         int32_t _pending_resize_amount;
2153         TimeAxisView* _pending_resize_view;
2154
2155         void visible_order_range (int*, int*) const;
2156
2157         void located ();
2158
2159         /** true if we've made a locate request that hasn't yet been processed */
2160         bool _pending_locate_request;
2161
2162         /** if true, there is a pending Session locate which is the initial one when loading a session;
2163             we need to know this so that we don't (necessarily) set the viewport to show the playhead
2164             initially.
2165         */
2166         bool _pending_initial_locate;
2167
2168         Gtk::HBox _summary_hbox;
2169         EditorSummary* _summary;
2170
2171         void region_view_added (RegionView *);
2172         void region_view_removed ();
2173
2174         EditorGroupTabs* _group_tabs;
2175         void fit_route_group (ARDOUR::RouteGroup *);
2176
2177         void step_edit_status_change (bool);
2178         void start_step_editing ();
2179         void stop_step_editing ();
2180         bool check_step_edit ();
2181         sigc::connection step_edit_connection;
2182
2183         double _last_motion_y;
2184
2185         RegionLayeringOrderEditor* layering_order_editor;
2186         void update_region_layering_order_editor ();
2187
2188         /** Track that was the source for the last cut/copy operation.  Used as a place
2189             to paste things iff there is no selected track.
2190         */
2191         TimeAxisView* _last_cut_copy_source_track;
2192
2193         /** true if a change in Selection->regions should change the selection in the region list.
2194             See EditorRegions::selection_changed.
2195         */
2196         bool _region_selection_change_updates_region_list;
2197
2198         void setup_fade_images ();
2199         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_in_images;
2200         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_out_images;
2201         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_in_images;
2202         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_out_images;
2203
2204         Gtk::MenuItem& action_menu_item (std::string const &);
2205         void action_pre_activated (Glib::RefPtr<Gtk::Action> const &);
2206
2207         MouseCursors* _cursors;
2208
2209         void follow_mixer_selection ();
2210         bool _following_mixer_selection;
2211
2212         int time_fx (ARDOUR::RegionList&, float val, bool pitching);
2213         void note_edit_done (int, EditNoteDialog*);
2214         void toggle_sound_midi_notes ();
2215
2216         /** Flag for a bit of a hack wrt control point selection; see set_selected_control_point_from_click */
2217         bool _control_point_toggled_on_press;
2218
2219         /** This is used by TimeAxisView to keep a track of the TimeAxisView that is currently being
2220             stepped in height using ScrollZoomVerticalModifier+Scrollwheel.  When a scroll event
2221             occurs, we do the step on this _stepping_axis_view if it is non-0 (and we set up this
2222             _stepping_axis_view with the TimeAxisView underneath the mouse if it is 0).  Then Editor
2223             resets _stepping_axis_view when the modifier key is released.  In this (hacky) way,
2224             pushing the modifier key and moving the scroll wheel will operate on the same track
2225             until the key is released (rather than skipping about to whatever happens to be
2226             underneath the mouse at the time).
2227         */
2228         TimeAxisView* _stepping_axis_view;
2229         void zoom_vertical_modifier_released();
2230
2231         void bring_in_callback (Gtk::Label*, uint32_t n, uint32_t total, std::string name);
2232         void update_bring_in_message (Gtk::Label* label, uint32_t n, uint32_t total, std::string name);
2233         void bring_all_sources_into_session ();
2234
2235         QuantizeDialog* quantize_dialog;
2236         MainMenuDisabler* _main_menu_disabler;
2237
2238         /* private helper functions to help with registering axis */
2239
2240         Glib::RefPtr<Gtk::Action> reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2241         void toggle_reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2242         void radio_reg_sens (Glib::RefPtr<Gtk::ActionGroup> action_group, Gtk::RadioAction::Group& radio_group, char const * name, char const * label, sigc::slot<void> slot);
2243
2244         Gtkmm2ext::ActionMap myactions;
2245
2246         friend class Drag;
2247         friend class RegionDrag;
2248         friend class RegionMoveDrag;
2249         friend class RegionSpliceDrag;
2250         friend class RegionRippleDrag;
2251         friend class TrimDrag;
2252         friend class MeterMarkerDrag;
2253         friend class TempoMarkerDrag;
2254         friend class CursorDrag;
2255         friend class FadeInDrag;
2256         friend class FadeOutDrag;
2257         friend class MarkerDrag;
2258         friend class RegionGainDrag;
2259         friend class ControlPointDrag;
2260         friend class LineDrag;
2261         friend class RubberbandSelectDrag;
2262         friend class EditorRubberbandSelectDrag;
2263         friend class TimeFXDrag;
2264         friend class ScrubDrag;
2265         friend class SelectionDrag;
2266         friend class RangeMarkerBarDrag;
2267         friend class MouseZoomDrag;
2268         friend class RegionCreateDrag;
2269         friend class RegionMotionDrag;
2270         friend class RegionInsertDrag;
2271         friend class VideoTimeLineDrag;
2272
2273         friend class EditorSummary;
2274         friend class EditorGroupTabs;
2275
2276         friend class EditorRoutes;
2277         friend class RhythmFerret;
2278 };
2279
2280 #endif /* __ardour_editor_h__ */