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