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