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