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::Group* parent,
  53                     TimeAxisView&        time_view,
  54                     boost::shared_ptr<ARDOUR::Region> region,
  55                     double               samples_per_pixel,
  56                     Gdk::Color const &   basic_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 (Gdk::Color const & base_color, 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         void fake_set_opaque (bool yn);
  83
  84         virtual void show_region_editor ();
  85         void hide_region_editor ();
  86
  87         virtual void region_changed (const PBD::PropertyChange&);
  88
  89         virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
  90         void remove_ghost_in (TimeAxisView&);
  91         void remove_ghost (GhostRegion*);
  92
  93         uint32_t get_fill_color ();
  94
  95         virtual void entered (bool) {}
  96         virtual void exited () {}
  97
  98         virtual void enable_display(bool yn) { _enable_display = yn; }
  99         virtual void update_coverage_frames (LayerDisplay);
 100
 101         static PBD::Signal1<void,RegionView*> RegionViewGoingAway;
 102
 103         ARDOUR::BeatsFramesConverter const & region_relative_time_converter () const {
 104                 return _region_relative_time_converter;
 105         }
 106
 107         ARDOUR::BeatsFramesConverter const & source_relative_time_converter () const {
 108                 return _source_relative_time_converter;
 109         }
 110
 111         /** Called when a front trim is about to begin */
 112         virtual void trim_front_starting () {}
 113
 114         bool trim_front (framepos_t, bool);
 115
 116         /** Called when a start trim has finished */
 117         virtual void trim_front_ending () {}
 118
 119         bool trim_end (framepos_t, bool);
 120         void move_contents (ARDOUR::frameoffset_t);
 121         virtual void thaw_after_trim ();
 122
 123         void set_silent_frames (const ARDOUR::AudioIntervalResult&, double threshold);
 124         void drop_silent_frames ();
 125         void hide_silent_frames ();
 126
 127         ARDOUR::frameoffset_t snap_frame_to_frame (ARDOUR::frameoffset_t) const;
 128
 129   protected:
 130
 131         /** Allows derived types to specify their visibility requirements
 132          * to the TimeAxisViewItem parent class
 133          */
 134         RegionView (ArdourCanvas::Group *,
 135                     TimeAxisView&,
 136                     boost::shared_ptr<ARDOUR::Region>,
 137                     double samples_per_pixel,
 138                     Gdk::Color const & basic_color,
 139                     bool recording,
 140                     TimeAxisViewItem::Visibility);
 141
 142         bool canvas_group_event (GdkEvent*);
 143
 144         virtual void region_resized (const PBD::PropertyChange&);
 145         virtual void region_muted ();
 146         void         region_locked ();
 147         void         region_opacity ();
 148         virtual void region_renamed ();
 149         void         region_sync_changed ();
 150
 151         std::string make_name () const;
 152
 153         static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
 154         void        lock_toggle ();
 155
 156         virtual void set_colors ();
 157         virtual void set_frame_color ();
 158         virtual void reset_width_dependent_items (double pixel_width);
 159
 160         virtual void color_handler () {}
 161
 162         boost::shared_ptr<ARDOUR::Region> _region;
 163
 164         ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
 165         ArdourCanvas::Line* sync_line; ///< polgyon for sync position
 166
 167         RegionEditor* editor;
 168
 169         std::vector<ControlPoint *> control_points;
 170         double current_visible_sync_position;
 171
 172         bool    valid; ///< see StreamView::redisplay_diskstream()
 173         bool    _enable_display; ///< see StreamView::redisplay_diskstream()
 174         double  _pixel_width;
 175         bool    in_destructor;
 176
 177         bool wait_for_data;
 178
 179         std::vector<GhostRegion*> ghosts;
 180
 181         /** a list of rectangles which are used in stacked display mode to colour
 182             different bits of regions according to whether or not they are the one
 183             that will be played at any given time.
 184         */
 185         std::list<ArdourCanvas::Rectangle*> _coverage_frames;
 186
 187         /** a list of rectangles used to show silent segments
 188         */
 189         std::list<ArdourCanvas::Rectangle*> _silent_frames;
 190         /** a list of rectangles used to show the current silence threshold
 191         */
 192         std::list<ArdourCanvas::Rectangle*> _silent_threshold_frames;
 193         /** a text item to display strip silence statistics
 194          */
 195         ArdourCanvas::Text* _silence_text;
 196
 197         ARDOUR::BeatsFramesConverter _region_relative_time_converter;
 198         ARDOUR::BeatsFramesConverter _source_relative_time_converter;
 199 };
 200
 201 #endif /* __gtk_ardour_region_view_h__ */