gtk2_ardour/region_view.h

   1 /*
   2     Copyright (C) 2001-2006 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 #ifndef __gtk_ardour_region_view_h__
  20 #define __gtk_ardour_region_view_h__
  21
  22 #include <vector>
  23
  24 #include <libgnomecanvasmm.h>
  25 #include <libgnomecanvasmm/polygon.h>
  26 #include <sigc++/signal.h>
  27 #include "ardour/region.h"
  28 #include "ardour/beats_frames_converter.h"
  29
  30 #include "time_axis_view_item.h"
  31 #include "automation_line.h"
  32 #include "enums.h"
  33 #include "canvas.h"
  34
  35 class TimeAxisView;
  36 class RegionEditor;
  37 class GhostRegion;
  38 class AutomationTimeAxisView;
  39 class AutomationRegionView;
  40
  41 class RegionView : public TimeAxisViewItem
  42 {
  43   public:
  44         RegionView (ArdourCanvas::Group* parent,
  45                     TimeAxisView&        time_view,
  46                     boost::shared_ptr<ARDOUR::Region> region,
  47                     double               samples_per_unit,
  48                     Gdk::Color const &   basic_color,
  49                     bool                 automation = false);
  50
  51         RegionView (const RegionView& other);
  52         RegionView (const RegionView& other, boost::shared_ptr<ARDOUR::Region> other_region);
  53
  54         ~RegionView ();
  55
  56         virtual void init (Gdk::Color const & base_color, bool wait_for_data);
  57
  58         boost::shared_ptr<ARDOUR::Region> region() const { return _region; }
  59
  60         bool is_valid() const    { return valid; }
  61
  62         void set_valid (bool yn) { valid = yn; }
  63
  64         virtual void set_height (double);
  65         virtual void set_samples_per_unit (double);
  66         virtual bool set_duration (framecnt_t, void*);
  67
  68         void move (double xdelta, double ydelta);
  69
  70         void raise_to_top ();
  71         void lower_to_bottom ();
  72
  73         bool set_position(framepos_t pos, void* src, double* delta = 0);
  74         void fake_set_opaque (bool yn);
  75
  76         virtual void show_region_editor ();
  77         void hide_region_editor ();
  78
  79         virtual void region_changed (const PBD::PropertyChange&);
  80
  81         virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
  82         void remove_ghost_in (TimeAxisView&);
  83         void remove_ghost (GhostRegion*);
  84
  85         uint32_t get_fill_color ();
  86
  87         virtual void entered (bool) {}
  88         virtual void exited () {}
  89
  90         virtual void enable_display(bool yn) { _enable_display = yn; }
  91         virtual void update_coverage_frames (LayerDisplay);
  92
  93         static PBD::Signal1<void,RegionView*> RegionViewGoingAway;
  94
  95         ARDOUR::BeatsFramesConverter const & time_converter () {
  96                 return _time_converter;
  97         }
  98
  99         /** Called when a front trim is about to begin */
 100         virtual void trim_front_starting () {}
 101
 102         void trim_front (framepos_t, bool);
 103
 104         /** Called when a start trim has finished */
 105         virtual void trim_front_ending () {}
 106
 107         void trim_end (framepos_t, bool);
 108         void trim_contents (framepos_t, bool, bool);
 109         virtual void thaw_after_trim ();
 110
 111   protected:
 112
 113         /** Allows derived types to specify their visibility requirements
 114          * to the TimeAxisViewItem parent class
 115          */
 116         RegionView (ArdourCanvas::Group *,
 117                     TimeAxisView&,
 118                     boost::shared_ptr<ARDOUR::Region>,
 119                     double samples_per_unit,
 120                     Gdk::Color const & basic_color,
 121                     bool recording,
 122                     TimeAxisViewItem::Visibility);
 123
 124         virtual void region_resized (const PBD::PropertyChange&);
 125         virtual void region_muted ();
 126         void         region_locked ();
 127         void         region_opacity ();
 128         virtual void region_renamed ();
 129         void         region_sync_changed ();
 130
 131         std::string make_name () const;
 132
 133         static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
 134         void        lock_toggle ();
 135
 136         virtual void set_colors ();
 137         virtual void set_frame_color ();
 138         virtual void reset_width_dependent_items (double pixel_width);
 139
 140         virtual void color_handler () {}
 141
 142         boost::shared_ptr<ARDOUR::Region> _region;
 143
 144         ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
 145         ArdourCanvas::Line* sync_line; ///< polgyon for sync position
 146
 147         RegionEditor* editor;
 148
 149         std::vector<ControlPoint *> control_points;
 150         double current_visible_sync_position;
 151
 152         bool    valid; ///< see StreamView::redisplay_diskstream()
 153         bool    _enable_display; ///< see StreamView::redisplay_diskstream()
 154         double  _pixel_width;
 155         bool    in_destructor;
 156
 157         bool wait_for_data;
 158
 159         std::vector<GhostRegion*> ghosts;
 160
 161         /** a list of rectangles which are used in stacked display mode to colour
 162             different bits of regions according to whether or not they are the one
 163             that will be played at any given time.
 164         */
 165         std::list<ArdourCanvas::SimpleRect*> _coverage_frames;
 166
 167         ARDOUR::BeatsFramesConverter _time_converter;
 168 };
 169
 170 #endif /* __gtk_ardour_region_view_h__ */