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