substantive change to try to provide some rationality for region gain line visibility...
[ardour.git] / gtk2_ardour / audio_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_audio_region_view_h__
20 #define __gtk_ardour_audio_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/audioregion.h"
28
29 #include "region_view.h"
30 #include "time_axis_view_item.h"
31 #include "automation_line.h"
32 #include "enums.h"
33 #include "waveview.h"
34 #include "canvas.h"
35
36 namespace ARDOUR {
37         class AudioRegion;
38         struct PeakData;
39 };
40
41 class AudioTimeAxisView;
42 class AudioRegionGainLine;
43 class GhostRegion;
44 class AutomationTimeAxisView;
45 class RouteTimeAxisView;
46
47 class AudioRegionView : public RegionView
48 {
49   public:
50         AudioRegionView (ArdourCanvas::Group *,
51                          RouteTimeAxisView&,
52                          boost::shared_ptr<ARDOUR::AudioRegion>,
53                          double initial_samples_per_unit,
54                          Gdk::Color const & basic_color);
55
56         AudioRegionView (ArdourCanvas::Group *,
57                          RouteTimeAxisView&,
58                          boost::shared_ptr<ARDOUR::AudioRegion>,
59                          double samples_per_unit,
60                          Gdk::Color const & basic_color,
61                          bool recording,
62                          TimeAxisViewItem::Visibility);
63
64         AudioRegionView (const AudioRegionView& other, boost::shared_ptr<ARDOUR::AudioRegion>);
65
66         ~AudioRegionView ();
67
68         virtual void init (Gdk::Color const & base_color, bool wait_for_data);
69
70         boost::shared_ptr<ARDOUR::AudioRegion> audio_region() const;
71
72         void create_waves ();
73
74         void set_height (double);
75         void set_samples_per_unit (double);
76
77         void set_amplitude_above_axis (gdouble spp);
78
79         void temporarily_hide_envelope (); ///< Dangerous!
80         void unhide_envelope ();           ///< Dangerous!
81
82         void update_envelope_visible ();
83         void set_waveform_visible (bool yn);
84         void set_waveform_shape (ARDOUR::WaveformShape);
85         void set_waveform_scale (ARDOUR::WaveformScale);
86
87         bool waveform_rectified() const { return _flags & WaveformRectified; }
88         bool waveform_logscaled() const { return _flags & WaveformLogScaled; }
89         bool waveform_visible()   const { return _flags & WaveformVisible; }
90
91         void add_gain_point_event (ArdourCanvas::Item *item, GdkEvent *event);
92         void remove_gain_point_event (ArdourCanvas::Item *item, GdkEvent *event);
93
94         boost::shared_ptr<AudioRegionGainLine> get_gain_line() const { return gain_line; }
95
96         void region_changed (const PBD::PropertyChange&);
97         void envelope_active_changed ();
98
99         GhostRegion* add_ghost (TimeAxisView&);
100
101         void reset_fade_in_shape_width (framecnt_t);
102         void reset_fade_out_shape_width (framecnt_t);
103
104         void show_fade_line(framepos_t pos);
105         void hide_fade_line();
106
107         void set_fade_visibility (bool);
108         void update_coverage_frames (LayerDisplay);
109
110         void update_transient(float old_pos, float new_pos);
111         void remove_transient(float pos);
112
113         void show_region_editor ();
114
115         virtual void entered (bool);
116         virtual void exited ();
117
118         void thaw_after_trim ();
119
120         void drag_start ();
121         void drag_end ();
122
123         void redraw_start_xfade_to (boost::shared_ptr<ARDOUR::AudioRegion>, framecnt_t);
124         void redraw_end_xfade_to (boost::shared_ptr<ARDOUR::AudioRegion>, framecnt_t);
125         void redraw_start_xfade ();
126         void redraw_end_xfade ();
127         
128         void hide_xfades ();
129         void show_xfades ();
130
131   protected:
132
133         /* this constructor allows derived types
134            to specify their visibility requirements
135            to the TimeAxisViewItem parent class
136         */
137
138         enum Flags {
139                 WaveformVisible = 0x4,
140                 WaveformRectified = 0x8,
141                 WaveformLogScaled = 0x10,
142         };
143
144         std::vector<ArdourCanvas::WaveView *> waves;
145         std::vector<ArdourCanvas::WaveView *> tmp_waves; ///< see ::create_waves()
146
147         std::list<std::pair<framepos_t, ArdourCanvas::Line*> > feature_lines;
148
149         ArdourCanvas::Polygon*           sync_mark; ///< polgyon for sync position
150         ArdourCanvas::Polygon*           fade_in_shape;
151         ArdourCanvas::Polygon*           fade_out_shape;
152         ArdourCanvas::SimpleRect*        fade_in_handle; ///< fade in handle, or 0
153         ArdourCanvas::SimpleRect*        fade_out_handle; ///< fade out handle, or 0
154         ArdourCanvas::SimpleLine*        fade_position_line;
155
156         ArdourCanvas::Line *start_xfade_in;
157         ArdourCanvas::Line *start_xfade_out;
158         ArdourCanvas::SimpleRect* start_xfade_rect;
159
160         ArdourCanvas::Line *end_xfade_in;
161         ArdourCanvas::Line *end_xfade_out;
162         ArdourCanvas::SimpleRect* end_xfade_rect;
163
164         boost::shared_ptr<AudioRegionGainLine> gain_line;
165
166         double _amplitude_above_axis;
167
168         uint32_t _flags;
169         uint32_t fade_color;
170
171         void reset_fade_shapes ();
172         void reset_fade_in_shape ();
173         void reset_fade_out_shape ();
174         void fade_in_changed ();
175         void fade_out_changed ();
176         void fade_in_active_changed ();
177         void fade_out_active_changed ();
178
179         void region_resized (const PBD::PropertyChange&);
180         void region_muted ();
181         void region_scale_amplitude_changed ();
182         void region_renamed ();
183
184         void create_one_wave (uint32_t, bool);
185         void peaks_ready_handler (uint32_t);
186         void set_flags (XMLNode *);
187         void store_flags ();
188
189         void set_colors ();
190         void compute_colors (Gdk::Color const &);
191         void reset_width_dependent_items (double pixel_width);
192         void set_waveview_data_src();
193         void set_frame_color ();
194
195         void color_handler ();
196
197         std::vector<GnomeCanvasWaveViewCache*> wave_caches;
198
199         void transients_changed();
200
201         AutomationLine::VisibleAspects automation_line_visibility () const;
202
203 private:
204         void setup_fade_handle_positions ();
205
206         /** A ScopedConnection for each PeaksReady callback (one per channel).  Each member
207          *  may be 0 if no connection exists.
208          */
209         std::vector<PBD::ScopedConnection*> _data_ready_connections;
210 };
211
212 #endif /* __gtk_ardour_audio_region_view_h__ */