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