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_samples_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 set_selected (bool yn) {
  65                 _region->set_selected_for_solo(yn);
  66                 TimeAxisViewItem::set_selected(yn);
  67         }
  68
  69         virtual void init (bool wait_for_data);
  70
  71         boost::shared_ptr<ARDOUR::Region> region() const { return _region; }
  72
  73         bool is_valid() const    { return valid; }
  74
  75         void set_valid (bool yn) { valid = yn; }
  76
  77         virtual void set_height (double);
  78         virtual void set_samples_per_pixel (double);
  79         virtual bool set_duration (samplecnt_t, void*);
  80
  81         void move (double xdelta, double ydelta);
  82
  83         void raise_to_top ();
  84         void lower_to_bottom ();
  85
  86         bool set_position(samplepos_t pos, void* src, double* delta = 0);
  87
  88         virtual void show_region_editor ();
  89         void hide_region_editor ();
  90
  91         virtual void region_changed (const PBD::PropertyChange&);
  92
  93         uint32_t get_fill_color () const;
  94
  95         virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
  96         void remove_ghost_in (TimeAxisView&);
  97         void remove_ghost (GhostRegion*);
  98
  99         virtual void entered () {}
 100         virtual void exited () {}
 101
 102         virtual void enable_display(bool yn) { _enable_display = yn; }
 103         virtual void update_coverage_frame (LayerDisplay);
 104
 105         static PBD::Signal1<void,RegionView*> RegionViewGoingAway;
 106
 107         /** Called when a front trim is about to begin */
 108         virtual void trim_front_starting () {}
 109
 110         bool trim_front (samplepos_t, bool, const int32_t sub_num);
 111
 112         /** Called when a start trim has finished */
 113         virtual void trim_front_ending () {}
 114
 115         bool trim_end (samplepos_t, bool, const int32_t sub_num);
 116         void move_contents (ARDOUR::sampleoffset_t);
 117         virtual void thaw_after_trim ();
 118
 119         void set_silent_frames (const ARDOUR::AudioIntervalResult&, double threshold);
 120         void drop_silent_frames ();
 121         void hide_silent_frames ();
 122
 123         struct PositionOrder {
 124                 bool operator()(const RegionView* a, const RegionView* b) {
 125                         return a->region()->position() < b->region()->position();
 126                 }
 127         };
 128
 129         ARDOUR::MusicSample snap_sample_to_sample (ARDOUR::sampleoffset_t, bool ensure_snap = false) const;
 130
 131         void update_visibility ();
 132
 133 protected:
 134
 135         /** Allows derived types to specify their visibility requirements
 136          * to the TimeAxisViewItem parent class
 137          */
 138         RegionView (ArdourCanvas::Container *,
 139                     TimeAxisView&,
 140                     boost::shared_ptr<ARDOUR::Region>,
 141                     double samples_per_pixel,
 142                     uint32_t basic_color,
 143                     bool recording,
 144                     TimeAxisViewItem::Visibility);
 145
 146         bool canvas_group_event (GdkEvent*);
 147
 148         virtual void region_resized (const PBD::PropertyChange&);
 149         virtual void region_muted ();
 150         void         region_locked ();
 151         void         region_opacity ();
 152         virtual void region_renamed ();
 153         void         region_sync_changed ();
 154
 155         std::string make_name () const;
 156
 157         static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
 158         void        lock_toggle ();
 159
 160         virtual void set_colors ();
 161         virtual void set_sync_mark_color ();
 162         virtual void reset_width_dependent_items (double pixel_width);
 163
 164         virtual void color_handler () {}
 165
 166         boost::shared_ptr<ARDOUR::Region> _region;
 167
 168         ArdourCanvas::Polygon* sync_mark; ///< polgyon for sync position
 169         ArdourCanvas::Line* sync_line; ///< polgyon for sync position
 170
 171         RegionEditor* editor;
 172
 173         std::vector<ControlPoint *> control_points;
 174         double current_visible_sync_position;
 175
 176         bool    valid; ///< see StreamView::redisplay_diskstream()
 177         bool    _enable_display; ///< see StreamView::redisplay_diskstream()
 178         double  _pixel_width;
 179         bool    in_destructor;
 180
 181         bool wait_for_data;
 182
 183         std::vector<GhostRegion*> ghosts;
 184
 185         /** a list of rectangles which are used in stacked display mode to colour
 186          * different bits of regions according to whether or not they are the one
 187          * that will be played at any given time.
 188          */
 189         std::list<ArdourCanvas::Rectangle*> _coverage_frame;
 190
 191         /** a list of rectangles used to show silent segments
 192         */
 193         std::list<ArdourCanvas::Rectangle*> _silent_frames;
 194         /** a list of rectangles used to show the current silence threshold
 195         */
 196         std::list<ArdourCanvas::Rectangle*> _silent_threshold_samples;
 197         /** a text item to display strip silence statistics */
 198         ArdourCanvas::Text* _silence_text;
 199 };
 200
 201 #endif /* __gtk_ardour_region_view_h__ */