Add some comments to the RegionSelection class.
[ardour.git] / gtk2_ardour / analysis_window.cc
1 /*
2     Copyright (C) 2006 Paul Davis
3     Written by Sampo Savolainen
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 */
20
21 #include <gtkmm2ext/gtk_ui.h>
22 #include <gtkmm/stock.h>
23 #include <gtkmm/label.h>
24 #include <gtkmm/treemodel.h>
25 #include <gtkmm/treeiter.h>
26
27 #include <ardour/audioregion.h>
28 #include <ardour/audioplaylist.h>
29 #include <ardour/types.h>
30
31 #include "analysis_window.h"
32
33 #include "route_ui.h"
34 #include "time_axis_view.h"
35 #include "public_editor.h"
36 #include "selection.h"
37 #include "audio_region_view.h"
38
39 #include "i18n.h"
40
41 using namespace ARDOUR;
42 using namespace PBD;
43
44 AnalysisWindow::AnalysisWindow()
45         : ArdourDialog(_("analysis window")),
46         
47           source_selection_label       (_("Signal source")),
48           source_selection_ranges_rb   (_("Selected ranges")),
49           source_selection_regions_rb  (_("Selected regions")),
50         
51           display_model_label                   (_("Display model")),
52           display_model_composite_separate_rb   (_("Composite graphs for each track")),
53           display_model_composite_all_tracks_rb (_("Composite graph of all tracks")),
54
55           fft_graph (2048)
56 {
57         track_list_ready = false;
58         
59         // Left side: track list + controls
60         tlmodel = Gtk::ListStore::create(tlcols);
61         track_list.set_model (tlmodel);
62         track_list.append_column(_("Track"), tlcols.trackname);
63         track_list.append_column_editable(_("Show"), tlcols.visible);
64         track_list.set_headers_visible(true);
65         track_list.set_reorderable(false);
66         track_list.get_selection()->set_mode (Gtk::SELECTION_NONE);
67
68
69         Gtk::TreeViewColumn* track_col = track_list.get_column(0);
70         Gtk::CellRendererText* renderer = dynamic_cast<Gtk::CellRendererText*>(track_list.get_column_cell_renderer (0));
71         
72         track_col->add_attribute(renderer->property_foreground_gdk(), tlcols.color);
73         track_col->set_expand(true);
74
75
76         tlmodel->signal_row_changed().connect (
77                         mem_fun(*this, &AnalysisWindow::track_list_row_changed) );
78         
79         fft_graph.set_analysis_window(this);
80                 
81         vbox.pack_start(track_list);
82
83
84         // "Signal source"
85         vbox.pack_start(source_selection_label, false, false);
86
87         {
88                 Gtk::RadioButtonGroup group = source_selection_ranges_rb.get_group();
89                 source_selection_regions_rb.set_group(group);
90
91                 source_selection_ranges_rb.set_active();
92                 
93                 vbox.pack_start (source_selection_ranges_rb,  false, false);
94                 vbox.pack_start (source_selection_regions_rb, false, false);
95                 
96                 // "Selected ranges" radio
97                 source_selection_ranges_rb.signal_toggled().connect (
98                                 bind ( mem_fun(*this, &AnalysisWindow::source_selection_changed), &source_selection_ranges_rb));
99
100                 // "Selected regions" radio
101                 source_selection_regions_rb.signal_toggled().connect (
102                                 bind ( mem_fun(*this, &AnalysisWindow::source_selection_changed), &source_selection_regions_rb));
103         }
104         
105         vbox.pack_start(hseparator1, false, false);
106         
107         // "Display model"
108         vbox.pack_start(display_model_label, false, false);
109         {
110                 Gtk::RadioButtonGroup group = display_model_composite_separate_rb.get_group();
111                 display_model_composite_all_tracks_rb.set_group (group);
112                 
113                 display_model_composite_separate_rb.set_active();
114                 
115                 vbox.pack_start (display_model_composite_separate_rb,   false, false);
116                 vbox.pack_start (display_model_composite_all_tracks_rb, false, false);
117
118                 // "Composite graphs for all tracks"
119                 display_model_composite_separate_rb.signal_toggled().connect (
120                                 bind ( mem_fun(*this, &AnalysisWindow::display_model_changed), &display_model_composite_separate_rb));
121                 
122                 // "Composite graph of all tracks"
123                 display_model_composite_all_tracks_rb.signal_toggled().connect (
124                                 bind ( mem_fun(*this, &AnalysisWindow::display_model_changed), &display_model_composite_all_tracks_rb));
125         }
126
127         vbox.pack_start(hseparator2, false, false);
128
129         refresh_button.set_name("EditorGTKButton");
130         refresh_button.set_label(_("Analyze data"));
131
132         refresh_button.signal_clicked().connect ( bind ( mem_fun(*this, &AnalysisWindow::analyze_data), &refresh_button)); 
133
134         vbox.pack_start(refresh_button, false, false, 10);
135         
136         
137         hbox.pack_start(vbox);
138         
139         // Analysis window on the right
140         fft_graph.ensure_style();
141
142         hbox.add(fft_graph);
143         
144         
145
146         // And last we pack the hbox
147         get_vbox()->pack_start(hbox);
148
149         hbox.show();
150         vbox.show();
151         track_list.show();
152         source_selection_label.show();
153         source_selection_ranges_rb.show();
154         source_selection_regions_rb.show();
155         hseparator1.show();
156         display_model_label.show();
157         display_model_composite_separate_rb.show();
158         display_model_composite_all_tracks_rb.show();
159         hseparator2.show();
160         refresh_button.show();
161
162         //get_vbox()->show();
163 }
164
165 AnalysisWindow::~AnalysisWindow()
166 {
167
168 }
169
170 void
171 AnalysisWindow::set_rangemode()
172 {
173         source_selection_ranges_rb.set_active(true);
174 }
175
176 void
177 AnalysisWindow::set_regionmode()
178 {
179         source_selection_regions_rb.set_active(true);
180 }
181
182 void 
183 AnalysisWindow::track_list_row_changed(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter)
184 {
185         if (track_list_ready) {
186                 fft_graph.redraw();
187         }
188 }
189
190
191 void
192 AnalysisWindow::clear_tracklist()
193 {
194         // Empty track list & free old graphs
195         Gtk::TreeNodeChildren children = track_list.get_model()->children();
196         
197         for (Gtk::TreeIter i = children.begin(); i != children.end(); i++) {
198                 Gtk::TreeModel::Row row = *i;
199
200                 FFTResult *delete_me = row[tlcols.graph];
201                 if (delete_me == 0)
202                         continue;
203
204                 // Make sure it's not drawn
205                 row[tlcols.graph] = 0;
206                 
207                 delete delete_me;
208         }
209                 
210         tlmodel->clear();
211 }
212
213 void
214 AnalysisWindow::analyze()
215 {
216         analyze_data(&refresh_button);
217 }
218
219 void
220 AnalysisWindow::analyze_data (Gtk::Button *button)
221 {
222         track_list_ready = false;
223         {
224                 Glib::Mutex::Lock lm  (track_list_lock);
225
226                 // Empty track list & free old graphs
227                 clear_tracklist();
228         
229                 // first we gather the FFTResults of all tracks
230         
231                 Sample *buf    = (Sample *) malloc(sizeof(Sample) * fft_graph.windowSize());
232                 Sample *mixbuf = (Sample *) malloc(sizeof(Sample) * fft_graph.windowSize());
233                 float  *gain   = (float *)  malloc(sizeof(float) * fft_graph.windowSize());
234         
235                 Selection s = PublicEditor::instance().get_selection();
236                 TimeSelection ts = s.time;
237                 RegionSelection ars = s.regions;
238         
239                 for (TrackSelection::iterator i = s.tracks.begin(); i != s.tracks.end(); ++i) {
240                         boost::shared_ptr<AudioPlaylist> pl
241                                 = boost::dynamic_pointer_cast<AudioPlaylist>((*i)->playlist());
242
243                         if (!pl)
244                                 continue;
245
246                         RouteUI *rui = dynamic_cast<RouteUI *>(*i);
247                         
248                         // Busses don't have playlists, so we need to check that we actually are working with a playlist
249                         if (!pl || !rui)
250                                 continue;
251
252                         FFTResult *res = fft_graph.prepareResult(rui->color(), rui->route()->name());
253                 
254                         // if timeSelection
255                         if (source_selection_ranges_rb.get_active()) {
256 //                              cerr << "Analyzing ranges on track " << *&rui->route().name() << endl;
257                                 
258                                 for (std::list<AudioRange>::iterator j = ts.begin(); j != ts.end(); ++j) {
259
260                                         nframes_t i = 0;
261                                         int n;
262                         
263                                         while ( i < (*j).length() ) {
264                                                 // TODO: What about stereo+ channels? composite all to one, I guess
265
266                                                 n = fft_graph.windowSize();
267
268                                                 if (i + n >= (*j).length() ) {
269                                                         n = (*j).length() - i;
270                                                 }
271                                 
272                                                 n = pl->read(buf, mixbuf, gain, (*j).start + i, n);
273         
274                                                 if ( n < fft_graph.windowSize()) {
275                                                         for (int j = n; j < fft_graph.windowSize(); j++) {
276                                                                 buf[j] = 0.0;
277                                                         }
278                                                 }
279         
280                                                 res->analyzeWindow(buf);
281                                 
282                                                 i += n;
283                                         }
284                                 }
285                         } else if (source_selection_regions_rb.get_active()) {
286 //                              cerr << "Analyzing selected regions on track " << *&rui->route().name() << endl;
287                                 
288                                 TimeAxisView *current_axis = (*i);
289                                 
290                                 for (RegionSelection::iterator j = ars.begin(); j != ars.end(); ++j) {
291                                         // Check that the region is actually audio (so we can analyze it)
292                                         AudioRegionView* arv = dynamic_cast<AudioRegionView*>(*j);
293                                         if (!arv)
294                                                 continue;
295                                         
296                                         // Check that the region really is selected on _this_ track/solo
297                                         if ( &arv->get_time_axis_view() != current_axis)
298                                                 continue;
299
300 //                                      cerr << " - " << (*j)->region().name() << ": " << (*j)->region().length() << " samples starting at " << (*j)->region().position() << endl;
301                                         nframes_t i = 0;
302                                         int n;
303
304                                         while ( i < arv->region()->length() ) {
305                                                 // TODO: What about stereo+ channels? composite all to one, I guess
306
307                                                 n = fft_graph.windowSize();
308                                                 if (i + n >= arv->region()->length() ) {
309                                                         n = arv->region()->length() - i;
310                                                 }
311
312                                                 n = arv->audio_region()->read_at(buf, mixbuf, gain, arv->region()->position() + i, n);
313         
314                                                 if ( n < fft_graph.windowSize()) {
315                                                         for (int j = n; j < fft_graph.windowSize(); j++) {
316                                                                 buf[j] = 0.0;
317                                                         }
318                                                 }
319         
320                                                 res->analyzeWindow(buf);
321                                 
322                                                 i += n;
323                                         }
324 //                                      cerr << "Found: " << (*j)->get_item_name() << endl;
325
326                                 }
327
328                         }
329                         res->finalize();
330
331                                 
332                         Gtk::TreeModel::Row newrow = *(tlmodel)->append();
333                         newrow[tlcols.trackname]   = rui->route()->name();
334                         newrow[tlcols.visible]     = true;
335                         newrow[tlcols.color]       = rui->color();
336                         newrow[tlcols.graph]       = res;
337                 }       
338
339         
340                 free(buf);
341                 free(mixbuf);
342
343                 track_list_ready = true;
344         } /* end lock */
345         
346         fft_graph.redraw();
347 }
348
349 void
350 AnalysisWindow::source_selection_changed (Gtk::RadioButton *button)
351 {
352         // We are only interested in activation signals, not deactivation signals
353         if (!button->get_active())
354                 return;
355
356         /*
357         cerr << "AnalysisWindow: signal source = ";
358         
359         if (button == &source_selection_ranges_rb) {
360                 cerr << "selected ranges" << endl;
361                 
362         } else if (button == &source_selection_regions_rb) {
363                 cerr << "selected regions" << endl;
364                 
365         } else {
366                 cerr << "unknown?" << endl;
367         }
368         */
369 }
370
371 void
372 AnalysisWindow::display_model_changed (Gtk::RadioButton *button)
373 {
374         // We are only interested in activation signals, not deactivation signals
375         if (!button->get_active())
376                 return;
377
378         /*
379         cerr << "AnalysisWindow: display model = ";
380         
381         if (button == &display_model_composite_separate_rb) {
382                 cerr << "separate composites of tracks" << endl;
383         } else if (button == &display_model_composite_all_tracks_rb) {
384                 cerr << "composite of all tracks" << endl;
385         } else {
386                 cerr << "unknown?" << endl;
387         }
388         */
389 }
390           
391