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