Merged with trunk R1283.
[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 "route_time_axis.h"
31 #include "time_axis_view_item.h"
32 #include "automation_line.h"
33 #include "enums.h"
34 #include "waveview.h"
35 #include "canvas.h"
36 #include "color.h"
37
38 namespace ARDOUR {
39         class AudioRegion;
40         class PeakData;
41 };
42
43 class AudioTimeAxisView;
44 class AudioRegionGainLine;
45 class AudioRegionEditor;
46 class GhostRegion;
47 class AutomationTimeAxisView;
48
49 class AudioRegionView : public RegionView
50 {
51   public:
52         AudioRegionView (ArdourCanvas::Group *, 
53                          RouteTimeAxisView&,
54                          boost::shared_ptr<ARDOUR::AudioRegion>,
55                          double initial_samples_per_unit,
56                          Gdk::Color& basic_color);
57
58         ~AudioRegionView ();
59         
60         virtual void init (Gdk::Color& base_color, bool wait_for_data = false);
61         
62         boost::shared_ptr<ARDOUR::AudioRegion> audio_region() const;
63         
64         void set_height (double);
65         void set_samples_per_unit (double);
66         
67         void set_amplitude_above_axis (gdouble spp);
68         
69         void temporarily_hide_envelope (); ///< Dangerous!
70         void unhide_envelope ();           ///< Dangerous!
71         
72         void set_envelope_visible (bool);
73         void set_waveform_visible (bool yn);
74         void set_waveform_shape (WaveformShape);
75         void set_waveform_scale (WaveformScale);
76         
77         bool waveform_rectified() const { return _flags & WaveformRectified; }
78         bool waveform_logscaled() const { return _flags & WaveformLogScaled; }
79         bool waveform_visible()   const { return _flags & WaveformVisible; }
80         bool envelope_visible()   const { return _flags & EnvelopeVisible; }
81         
82         void show_region_editor ();
83         
84         void add_gain_point_event (ArdourCanvas::Item *item, GdkEvent *event);
85         void remove_gain_point_event (ArdourCanvas::Item *item, GdkEvent *event);
86         
87         AudioRegionGainLine* get_gain_line() const { return gain_line; }
88         
89         void region_changed (ARDOUR::Change);
90         void envelope_active_changed ();
91         
92         GhostRegion* add_ghost (AutomationTimeAxisView&);
93         
94         void reset_fade_in_shape_width (nframes_t);
95         void reset_fade_out_shape_width (nframes_t);
96         void set_fade_in_active (bool);
97         void set_fade_out_active (bool);
98         void set_fade_in_shape (ARDOUR::AudioRegion::FadeShape);
99         void set_fade_out_shape (ARDOUR::AudioRegion::FadeShape);
100
101         virtual void entered ();
102         virtual void exited ();
103         
104   protected:
105
106     /* this constructor allows derived types
107        to specify their visibility requirements
108        to the TimeAxisViewItem parent class
109     */
110     
111     AudioRegionView (ArdourCanvas::Group *, 
112                      RouteTimeAxisView&,
113                      boost::shared_ptr<ARDOUR::AudioRegion>,
114                      double      samples_per_unit,
115                      Gdk::Color& basic_color,
116                      TimeAxisViewItem::Visibility);
117     
118     enum Flags {
119             EnvelopeVisible = 0x1,
120             WaveformVisible = 0x4,
121             WaveformRectified = 0x8,
122             WaveformLogScaled = 0x10,
123     };
124
125     vector<ArdourCanvas::WaveView *> waves;
126     vector<ArdourCanvas::WaveView *> tmp_waves; ///< see ::create_waves()
127     ArdourCanvas::Polygon*           sync_mark; ///< polgyon for sync position 
128     ArdourCanvas::SimpleLine*        zero_line;
129     ArdourCanvas::Polygon*           fade_in_shape;
130     ArdourCanvas::Polygon*           fade_out_shape;
131     ArdourCanvas::SimpleRect*        fade_in_handle;
132     ArdourCanvas::SimpleRect*        fade_out_handle;
133     
134     AudioRegionGainLine * gain_line;
135
136     double _amplitude_above_axis;
137
138     uint32_t _flags;
139     uint32_t fade_color;
140     
141     void reset_fade_shapes ();
142     void reset_fade_in_shape ();
143     void reset_fade_out_shape ();
144     void fade_in_changed ();
145     void fade_out_changed ();
146     void fade_in_active_changed ();
147     void fade_out_active_changed ();
148
149     void region_resized (ARDOUR::Change);
150     void region_moved (void *);
151     void region_muted ();
152     void region_scale_amplitude_changed ();
153         void region_renamed ();
154
155     void create_waves ();
156     void create_one_wave (uint32_t, bool);
157     void manage_zero_line ();
158     void peaks_ready_handler (uint32_t);
159     void set_flags (XMLNode *);
160     void store_flags ();
161
162     void set_colors ();
163     void compute_colors (Gdk::Color&);
164     void reset_width_dependent_items (double pixel_width);
165     void set_waveview_data_src();
166
167     vector<GnomeCanvasWaveViewCache*> wave_caches;
168     
169     void color_handler (ColorID, uint32_t);
170 };
171
172 #endif /* __gtk_ardour_audio_region_view_h__ */