gtk2_ardour/automation_line.h

   1 /*
   2     Copyright (C) 2002 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_automation_line_h__
  21 #define __ardour_automation_line_h__
  22
  23 #include <vector>
  24 #include <list>
  25 #include <string>
  26 #include <sys/types.h>
  27
  28 #include <sigc++/signal.h>
  29
  30 #include "evoral/TimeConverter.hpp"
  31
  32 #include "pbd/undo.h"
  33 #include "pbd/statefuldestructible.h"
  34 #include "pbd/memento_command.h"
  35
  36 #include "ardour/automation_list.h"
  37 #include "ardour/types.h"
  38
  39 #include "canvas/types.h"
  40 #include "canvas/container.h"
  41 #include "canvas/poly_line.h"
  42
  43 class AutomationLine;
  44 class ControlPoint;
  45 class PointSelection;
  46 class TimeAxisView;
  47 class AutomationTimeAxisView;
  48 class Selectable;
  49 class Selection;
  50 class PublicEditor;
  51
  52
  53 /** A GUI representation of an ARDOUR::AutomationList */
  54 class AutomationLine : public sigc::trackable, public PBD::StatefulDestructible
  55 {
  56 public:
  57         enum VisibleAspects {
  58                 Line = 0x1,
  59                 ControlPoints = 0x2,
  60                 SelectedControlPoints = 0x4
  61         };
  62
  63         AutomationLine (const std::string& name, TimeAxisView&, ArdourCanvas::Item&,
  64                         boost::shared_ptr<ARDOUR::AutomationList>,
  65                         Evoral::TimeConverter<double, ARDOUR::framepos_t>* converter = 0);
  66         virtual ~AutomationLine ();
  67
  68         void queue_reset ();
  69         void reset ();
  70         void clear ();
  71
  72         void set_selected_points (PointSelection const &);
  73         void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
  74         void get_inverted_selectables (Selection&, std::list<Selectable*>& results);
  75
  76         virtual void remove_point (ControlPoint&);
  77         bool control_points_adjacent (double xval, uint32_t& before, uint32_t& after);
  78
  79         /* dragging API */
  80         virtual void start_drag_single (ControlPoint*, double, float);
  81         virtual void start_drag_line (uint32_t, uint32_t, float);
  82         virtual void start_drag_multiple (std::list<ControlPoint*>, float, XMLNode *);
  83         virtual std::pair<double, float> drag_motion (double, float, bool, bool with_push, uint32_t& final_index);
  84         virtual void end_drag (bool with_push, uint32_t final_index);
  85
  86         ControlPoint* nth (uint32_t);
  87         ControlPoint const * nth (uint32_t) const;
  88         uint32_t npoints() const { return control_points.size(); }
  89
  90         std::string  name()    const { return _name; }
  91         bool    visible() const { return _visible != VisibleAspects(0); }
  92         guint32 height()  const { return _height; }
  93
  94         void     set_line_color (uint32_t);
  95         uint32_t get_line_color() const { return _line_color; }
  96
  97         void set_visibility (VisibleAspects);
  98         void add_visibility (VisibleAspects);
  99         void remove_visibility (VisibleAspects);
 100
 101         void hide ();
 102         void set_height (guint32);
 103         void set_uses_gain_mapping (bool yn);
 104         bool get_uses_gain_mapping () const { return _uses_gain_mapping; }
 105
 106         TimeAxisView& trackview;
 107
 108         ArdourCanvas::Container& canvas_group() const { return *group; }
 109         ArdourCanvas::Item&  parent_group() const { return _parent_group; }
 110         ArdourCanvas::Item&  grab_item() const { return *line; }
 111
 112         virtual std::string get_verbose_cursor_string (double) const;
 113         std::string get_verbose_cursor_relative_string (double, double) const;
 114         std::string fraction_to_string (double) const;
 115         std::string fraction_to_relative_string (double, double) const;
 116         double string_to_fraction (std::string const &) const;
 117         void   view_to_model_coord (double& x, double& y) const;
 118         void   view_to_model_coord_y (double &) const;
 119         void   model_to_view_coord (double& x, double& y) const;
 120
 121         void set_list(boost::shared_ptr<ARDOUR::AutomationList> list);
 122         boost::shared_ptr<ARDOUR::AutomationList> the_list() const { return alist; }
 123
 124         void track_entered();
 125         void track_exited();
 126
 127         bool is_last_point (ControlPoint &);
 128         bool is_first_point (ControlPoint &);
 129
 130         XMLNode& get_state (void);
 131         int set_state (const XMLNode&, int version);
 132         void set_colors();
 133
 134         void modify_point_y (ControlPoint&, double);
 135
 136         virtual MementoCommandBinder<ARDOUR::AutomationList>* memento_command_binder ();
 137
 138         const Evoral::TimeConverter<double, ARDOUR::framepos_t>& time_converter () const {
 139                 return *_time_converter;
 140         }
 141
 142         std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> get_point_x_range () const;
 143
 144         void set_maximum_time (ARDOUR::framecnt_t);
 145         ARDOUR::framecnt_t maximum_time () const {
 146                 return _maximum_time;
 147         }
 148
 149         void set_offset (ARDOUR::framecnt_t);
 150         void set_width (ARDOUR::framecnt_t);
 151
 152         framepos_t session_position (ARDOUR::AutomationList::const_iterator) const;
 153
 154 protected:
 155
 156         std::string    _name;
 157         guint32   _height;
 158         uint32_t  _line_color;
 159
 160         boost::shared_ptr<ARDOUR::AutomationList> alist;
 161         Evoral::TimeConverter<double, ARDOUR::framepos_t>* _time_converter;
 162         /** true if _time_converter belongs to us (ie we should delete it on destruction) */
 163         bool _our_time_converter;
 164
 165         VisibleAspects _visible;
 166
 167         bool    _uses_gain_mapping;
 168         bool    terminal_points_can_slide;
 169         bool    update_pending;
 170         bool    have_timeout;
 171         bool    no_draw;
 172         bool    _is_boolean;
 173         /** true if we did a push at any point during the current drag */
 174         bool    did_push;
 175
 176         ArdourCanvas::Item&        _parent_group;
 177         ArdourCanvas::Container*       group;
 178         ArdourCanvas::PolyLine*     line; /* line */
 179         ArdourCanvas::Points        line_points; /* coordinates for canvas line */
 180         std::vector<ControlPoint*>  control_points; /* visible control points */
 181
 182         class ContiguousControlPoints : public std::list<ControlPoint*> {
 183 public:
 184                 ContiguousControlPoints (AutomationLine& al);
 185                 double clamp_dx (double dx);
 186                 void move (double dx, double dy);
 187                 void compute_x_bounds (PublicEditor& e);
 188 private:
 189                 AutomationLine& line;
 190                 double before_x;
 191                 double after_x;
 192         };
 193
 194         friend class ContiguousControlPoints;
 195
 196         typedef boost::shared_ptr<ContiguousControlPoints> CCP;
 197         std::vector<CCP> contiguous_points;
 198
 199         void sync_model_with_view_point (ControlPoint&);
 200         void sync_model_with_view_points (std::list<ControlPoint*>);
 201         void start_drag_common (double, float);
 202
 203         virtual void change_model (ARDOUR::AutomationList::iterator, double x, double y);
 204
 205         void reset_callback (const Evoral::ControlList&);
 206         void list_changed ();
 207
 208         virtual bool event_handler (GdkEvent*);
 209
 210 private:
 211         std::list<ControlPoint*> _drag_points; ///< points we are dragging
 212         std::list<ControlPoint*> _push_points; ///< additional points we are dragging if "push" is enabled
 213         bool _drag_had_movement; ///< true if the drag has seen movement, otherwise false
 214         double _drag_x; ///< last x position of the drag, in units
 215         double _drag_distance; ///< total x movement of the drag, in canvas units
 216         double _last_drag_fraction; ///< last y position of the drag, as a fraction
 217         /** offset from the start of the automation list to the start of the line, so that
 218          *  a +ve offset means that the 0 on the line is at _offset in the list
 219          */
 220         ARDOUR::framecnt_t _offset;
 221
 222         void update_visibility ();
 223         void reset_line_coords (ControlPoint&);
 224         void add_visible_control_point (uint32_t, uint32_t, double, double, ARDOUR::AutomationList::iterator, uint32_t);
 225         double control_point_box_size ();
 226         void connect_to_list ();
 227         void interpolation_changed (ARDOUR::AutomationList::InterpolationStyle);
 228
 229         PBD::ScopedConnectionList _list_connections;
 230
 231         /** maximum time that a point on this line can be at, relative to the position of its region or start of its track */
 232         ARDOUR::framecnt_t _maximum_time;
 233
 234         friend class AudioRegionGainLine;
 235 };
 236
 237 #endif /* __ardour_automation_line_h__ */
 238