gtk2_ardour/time_axis_view.h

   1 /*
   2     Copyright (C) 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_gtk_time_axis_h__
  21 #define __ardour_gtk_time_axis_h__
  22
  23 #include <vector>
  24 #include <list>
  25
  26 #include <boost/enable_shared_from_this.hpp>
  27
  28 #include <gtkmm/box.h>
  29 #include <gtkmm/frame.h>
  30 #include <gtkmm/drawingarea.h>
  31 #include <gtkmm/eventbox.h>
  32 #include <gtkmm/table.h>
  33 #include <gtkmm/entry.h>
  34 #include <gtkmm/label.h>
  35
  36 #include <gtkmm2ext/focus_entry.h>
  37
  38 #include "pbd/stateful.h"
  39
  40 #include "ardour/types.h"
  41 #include "ardour/region.h"
  42 #include "evoral/Parameter.hpp"
  43
  44 #include "prompter.h"
  45 #include "axis_view.h"
  46 #include "enums.h"
  47 #include "editing.h"
  48 #include "canvas.h"
  49 #include "shared_ptrs.h"
  50
  51 namespace ARDOUR {
  52         class Session;
  53         class Region;
  54         class Session;
  55         class RouteGroup;
  56         class Playlist;
  57 }
  58
  59 namespace Gtk {
  60         class Menu;
  61 }
  62
  63 class PublicEditor;
  64 class RegionSelection;
  65 class TimeSelection;
  66 class PointSelection;
  67 class TimeAxisViewItem;
  68 class Selection;
  69 class Selectable;
  70 class RegionView;
  71 class GhostRegion;
  72 class StreamView;
  73
  74 /** Abstract base class for time-axis views (horizontal editor 'strips')
  75  *
  76  * This class provides the basic LHS controls and display methods. This should be
  77  * extended to create functional time-axis based views.
  78  */
  79 class TimeAxisView : public virtual AxisView, public PBD::Stateful, public boost::enable_shared_from_this<TimeAxisView>
  80 {
  81   private:
  82         enum NamePackingBits {
  83                 NameLabelPacked = 0x1,
  84                 NameEntryPacked = 0x2
  85         };
  86
  87   public:
  88         static uint32_t hLargest;
  89         static uint32_t hLarge;
  90         static uint32_t hLarger;
  91         static uint32_t hNormal;
  92         static uint32_t hSmaller;
  93         static uint32_t hSmall;
  94
  95         TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisViewPtr parent, ArdourCanvas::Canvas& canvas);
  96         virtual ~TimeAxisView ();
  97
  98         XMLNode& get_state ();
  99         int set_state (const XMLNode&);
 100
 101         /** @return index of this TimeAxisView within its parent */
 102         int order () const { return _order; }
 103
 104         /** @return maximum allowable value of order */
 105         static int max_order () { return _max_order; }
 106
 107         ArdourCanvas::Group* canvas_display () { return _canvas_display; }
 108         ArdourCanvas::Group* canvas_background () { return _canvas_background; }
 109         ArdourCanvas::Group* ghost_group () { return _ghost_group; }
 110
 111         /** @return effective height (taking children into account) in canvas units, or
 112             0 if this TimeAxisView has not yet been shown */
 113         uint32_t effective_height () const { return _effective_height; }
 114
 115         /** @return y position, or -1 if hidden */
 116         double y_position () const { return _y_position; }
 117
 118         /** @return our Editor */
 119         PublicEditor& editor () const { return _editor; }
 120
 121         uint32_t current_height() const { return height; }
 122
 123         bool resizer_button_press (GdkEventButton*);
 124         bool resizer_button_release (GdkEventButton*);
 125         bool resizer_motion (GdkEventMotion*);
 126         bool resizer_expose (GdkEventExpose*);
 127
 128         void idle_resize (uint32_t);
 129
 130         void hide_name_label ();
 131         void hide_name_entry ();
 132         void show_name_label ();
 133         void show_name_entry ();
 134
 135         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 136
 137         void clip_to_viewport ();
 138
 139         bool touched (double top, double bot);
 140
 141         /** Hide this TrackView */
 142         virtual void hide ();
 143
 144         /** @return true if hidden, otherwise false */
 145         bool hidden () const { return _hidden; }
 146
 147         virtual void set_selected (bool);
 148
 149         /**
 150          * potential handler for entered events
 151          */
 152
 153         virtual void entered () {}
 154         virtual void exited () {}
 155
 156         virtual void set_height (uint32_t h);
 157         void reset_height();
 158
 159         std::pair<TimeAxisViewPtr, ARDOUR::layer_t> covers_y_position (double);
 160
 161         /**
 162          * Steps through the defined heights for this TrackView.
 163          * Sets bigger to true to step up in size, set to fals eot step smaller.
 164          *
 165          * @param bigger true if stepping should increase in size, false otherwise
 166          */
 167         virtual void step_height (bool bigger);
 168
 169         virtual ARDOUR::RouteGroup* route_group() const { return 0; }
 170         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 171
 172         virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
 173         virtual void hide_feature_lines ();
 174
 175         virtual void set_samples_per_unit (double);
 176         virtual void show_selection (TimeSelection&);
 177         virtual void hide_selection ();
 178         virtual void reshow_selection (TimeSelection&);
 179         virtual void show_timestretch (nframes_t start, nframes_t end);
 180         virtual void hide_timestretch ();
 181
 182         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 183         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 184
 185         /* editing operations */
 186
 187         virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
 188         virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
 189
 190         virtual void set_selected_regionviews (RegionSelection&) {}
 191         virtual void set_selected_points (PointSelection&) {}
 192
 193         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
 194                 return boost::shared_ptr<ARDOUR::Region> ();
 195         }
 196
 197         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 198
 199         virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, std::list<Selectable*>& results);
 200         virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 201
 202         void add_ghost (RegionView*);
 203         void remove_ghost (RegionView*);
 204         void erase_ghost (GhostRegion*);
 205
 206         /** called at load time when first GUI idle occurs. put
 207             expensive data loading/redisplay code in here. */
 208         virtual void first_idle () {}
 209
 210         TimeAxisViewPtr get_parent () { return parent; }
 211         void set_parent (TimeAxisViewPtr p);
 212         bool has_state () const;
 213
 214         /* call this on the parent */
 215
 216         virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param) { return 0; }
 217
 218         virtual LayerDisplay layer_display () const { return Overlaid; }
 219         virtual StreamView* view () const { return 0; }
 220
 221         TimeAxisViewPtr find_time_axis (TimeAxisView *);
 222
 223         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 224
 225   protected:
 226         /* The Standard LHS Controls */
 227         Gtk::HBox     controls_hbox;
 228         Gtk::Table    controls_table;
 229         Gtk::EventBox controls_ebox;
 230         Gtk::VBox     controls_vbox;
 231         Gtk::DrawingArea resizer;
 232         Gtk::HBox     resizer_box;
 233         Gtk::HBox     name_hbox;
 234         Gtk::Frame    name_frame;
 235         Gtkmm2ext::FocusEntry name_entry;
 236
 237         uint32_t height;  /* in canvas units */
 238
 239         std::string controls_base_unselected_name;
 240         std::string controls_base_selected_name;
 241
 242         bool name_entry_button_press (GdkEventButton *ev);
 243         bool name_entry_button_release (GdkEventButton *ev);
 244         bool name_entry_key_release (GdkEventKey *ev);
 245         void name_entry_activated ();
 246         sigc::connection name_entry_key_timeout;
 247         bool name_entry_key_timed_out ();
 248         guint32 last_name_entry_key_press_event;
 249
 250         /* derived classes can override these */
 251
 252         virtual void name_entry_changed ();
 253         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 254         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 255
 256         /** Handle mouse relaese on our LHS control name ebox.
 257          *
 258          *@ param ev the event
 259          */
 260         virtual bool controls_ebox_button_release (GdkEventButton *ev);
 261         virtual bool controls_ebox_scroll (GdkEventScroll *ev);
 262
 263         /** Display the standard LHS control menu at when.
 264          *
 265          * @param when the popup activation time
 266          */
 267         virtual void popup_display_menu (guint32 when);
 268
 269         /** Build the standard LHS control menu.
 270          * Subclasses should extend this method to add their own menu options.
 271          */
 272         virtual void build_display_menu ();
 273
 274         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 275          */
 276         virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
 277
 278         /** Build the standard LHS control size menu for the default heights options.
 279          */
 280         virtual void build_size_menu();
 281
 282         /** Displays the standard LHS controls size menu for the track heights
 283          *
 284          * @param when the popup activation time
 285          */
 286         void popup_size_menu(guint32 when);
 287
 288         /** Handle the size option of our main menu.
 289          *
 290          * @param ev the event
 291          */
 292         gint size_click(GdkEventButton *ev);
 293
 294         /* The standard LHS Track control popup-menus */
 295
 296         Gtk::Menu *display_menu;
 297         Gtk::Menu *size_menu;
 298
 299         Gtk::Label    name_label;
 300
 301         TimeAxisViewPtr parent;
 302
 303         /** Find the parent with state */
 304         TimeAxisViewPtr get_parent_with_state();
 305
 306         Children children;
 307         bool is_child (TimeAxisViewPtr);
 308
 309         void remove_child (TimeAxisViewPtr);
 310         void add_child (TimeAxisViewPtr);
 311
 312         /* selection display */
 313
 314         ArdourCanvas::Group      *selection_group;
 315
 316         std::list<GhostRegion*> ghosts;
 317
 318         std::list<SelectionRect*> free_selection_rects;
 319         std::list<SelectionRect*> used_selection_rects;
 320
 321         SelectionRect* get_selection_rect(uint32_t id);
 322
 323         virtual void selection_click (GdkEventButton*);
 324
 325         bool _hidden;
 326         bool _has_state;
 327         bool in_destructor;
 328         NamePackingBits name_packing;
 329
 330         static void compute_controls_size_info ();
 331         static bool need_size_info;
 332
 333         void set_heights (uint32_t h);
 334         void color_handler ();
 335
 336         std::list<ArdourCanvas::SimpleLine*> feature_lines;
 337         ARDOUR::AnalysisFeatureList analysis_features;
 338         void reshow_feature_lines ();
 339
 340         void conditionally_add_to_selection ();
 341
 342         ArdourCanvas::Group* _canvas_display;
 343         double _y_position;
 344         PublicEditor& _editor;
 345
 346 private:
 347
 348         ArdourCanvas::Group* _canvas_background;
 349         Gtk::VBox* control_parent;
 350         int _order;
 351         uint32_t _effective_height;
 352         double _resize_drag_start;
 353         ArdourCanvas::Group* _ghost_group;
 354
 355         static int const _max_order;
 356
 357 }; /* class TimeAxisView */
 358
 359 #endif /* __ardour_gtk_time_axis_h__ */
 360