No-op; coding style.
[ardour.git] / gtk2_ardour / strip_silence_dialog.cc
1 /*
2     Copyright (C) 2009 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
20 #include <iostream>
21
22 #include <gtkmm/table.h>
23 #include <gtkmm/label.h>
24 #include <gtkmm/stock.h>
25 #include "ardour/audioregion.h"
26 #include "ardour/audiosource.h"
27
28 #include "ardour/dB.h"
29 #include "ardour_ui.h"
30 #include "ardour/session.h"
31
32 #include "gui_thread.h"
33 #include "strip_silence_dialog.h"
34 #include "canvas_impl.h"
35 #include "region_view.h"
36 #include "simpleline.h"
37 #include "waveview.h"
38 #include "simplerect.h"
39 #include "rgb_macros.h"
40 #include "i18n.h"
41 #include "logmeter.h"
42
43 using namespace ARDOUR;
44 using namespace std;
45 using namespace ArdourCanvas;
46
47 /** Construct Strip silence dialog box */
48 StripSilenceDialog::StripSilenceDialog (Session* s, list<RegionView*> const & v)
49         : ArdourDialog (_("Strip Silence"))
50         , ProgressReporter ()
51         , _minimum_length (X_("silence duration"), true, "SilenceDurationClock", true, false, true, false)
52         , _fade_length (X_("silence duration"), true, "SilenceDurationClock", true, false, true, false)
53         , _peaks_ready_connection (0)
54         , _destroying (false)
55 {
56         set_session (s);
57
58         for (list<RegionView*>::const_iterator r = v.begin(); r != v.end(); ++r) {
59                 views.push_back (ViewInterval (*r));
60         }
61
62         Gtk::HBox* hbox = Gtk::manage (new Gtk::HBox);
63         
64         Gtk::Table* table = Gtk::manage (new Gtk::Table (3, 3));
65         table->set_spacings (6);
66
67         int n = 0;
68
69         table->attach (*Gtk::manage (new Gtk::Label (_("Threshold"), 1, 0.5)), 0, 1, n, n + 1, Gtk::FILL);
70         table->attach (_threshold, 1, 2, n, n + 1, Gtk::FILL);
71         table->attach (*Gtk::manage (new Gtk::Label (_("dbFS"))), 2, 3, n, n + 1, Gtk::FILL);
72         ++n;
73         
74         _threshold.set_digits (1);
75         _threshold.set_increments (1, 10);
76         _threshold.set_range (-120, 0);
77         _threshold.set_value (-60);
78
79         table->attach (*Gtk::manage (new Gtk::Label (_("Minimum length"), 1, 0.5)), 0, 1, n, n + 1, Gtk::FILL);
80         table->attach (_minimum_length, 1, 2, n, n + 1, Gtk::FILL);
81         ++n;
82         
83         _minimum_length.set_session (s);
84         _minimum_length.set_mode (AudioClock::Frames);
85         _minimum_length.set (1000, true);
86
87         /* Add this back when we finally do something with it */
88         /*
89         table->attach (*Gtk::manage (new Gtk::Label (_("Fade length"), 1, 0.5)), 0, 1, n, n + 1, Gtk::FILL);
90         table->attach (_fade_length, 1, 2, n, n + 1, Gtk::FILL);
91         ++n;
92         */
93
94         _fade_length.set_session (s);
95         _fade_length.set_mode (AudioClock::Frames);
96         _fade_length.set (64, true);
97
98         hbox->pack_start (*table);
99
100         get_vbox()->pack_start (*hbox, false, false);
101
102         add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
103         add_button (Gtk::Stock::APPLY, Gtk::RESPONSE_OK);
104
105         get_vbox()->pack_start (_progress_bar, true, true, 12);
106
107         show_all ();
108
109         _threshold.get_adjustment()->signal_value_changed().connect (sigc::mem_fun (*this, &StripSilenceDialog::threshold_changed));
110         _minimum_length.ValueChanged.connect (sigc::mem_fun (*this, &StripSilenceDialog::restart_thread));
111
112         update_silence_rects ();
113         update_threshold_line ();
114
115         /* Create a thread which runs while the dialogue is open to compute the silence regions */
116         Completed.connect (_completed_connection, MISSING_INVALIDATOR, ui_bind (&StripSilenceDialog::update, this), gui_context ());
117         _thread_should_finish = false;
118         pthread_create (&_thread, 0, StripSilenceDialog::_detection_thread_work, this);
119 }
120
121
122 StripSilenceDialog::~StripSilenceDialog ()
123 {
124         _destroying = true;
125         
126         /* Terminate our thread */
127         
128         _lock.lock ();
129         _interthread_info.cancel = true;
130         _thread_should_finish = true;
131         _lock.unlock ();
132
133         _run_cond.signal ();
134         pthread_join (_thread, 0);
135         
136         delete _peaks_ready_connection;
137 }
138
139 void
140 StripSilenceDialog::silences (AudioIntervalMap& m)
141 {
142         for (list<ViewInterval>::iterator v = views.begin(); v != views.end(); ++v) {
143                 pair<boost::shared_ptr<Region>,AudioIntervalResult> newpair (v->view->region(), v->intervals);
144                 m.insert (newpair);
145         }
146 }
147
148 void
149 StripSilenceDialog::drop_rects ()
150 {
151         for (list<ViewInterval>::iterator v = views.begin(); v != views.end(); ++v) {
152                 v->view->drop_silent_frames ();
153         }
154 }
155
156 void
157 StripSilenceDialog::update_threshold_line ()
158 {
159 #if 0
160         int n = 0;
161
162         /* Don't need to lock here as we're not reading the _waves silence details */
163
164         for (list<Wave*>::iterator i = _waves.begin(); i != _waves.end(); ++i) {
165                 (*i)->threshold_line->property_x1() = 0;
166                 (*i)->threshold_line->property_x2() = _wave_width;
167                 
168                 double const y = alt_log_meter (_threshold.get_value());
169
170                 (*i)->threshold_line->property_y1() = (n + 1 - y) * _wave_height;
171                 (*i)->threshold_line->property_y2() = (n + 1 - y) * _wave_height;
172         }
173
174         ++n;
175 #endif
176 }
177
178 void
179 StripSilenceDialog::update ()
180 {
181         update_threshold_line ();
182         update_silence_rects ();
183 }
184
185 void
186 StripSilenceDialog::update_silence_rects ()
187 {
188         /* Lock so that we don't contend with the detection thread for access to the silence regions */
189         Glib::Mutex::Lock lm (_lock);
190         double const y = _threshold.get_value();
191
192         for (list<ViewInterval>::iterator v = views.begin(); v != views.end(); ++v) {
193                 v->view->set_silent_frames (v->intervals, y);
194         }
195 }
196
197 void *
198 StripSilenceDialog::_detection_thread_work (void* arg)
199 {
200         StripSilenceDialog* d = reinterpret_cast<StripSilenceDialog*> (arg);
201         return d->detection_thread_work ();
202 }
203
204 /** Body of our silence detection thread */
205 void *
206 StripSilenceDialog::detection_thread_work ()
207 {
208         ARDOUR_UI::instance()->register_thread ("gui", pthread_self(), "silence", 32);
209
210         /* Hold this lock when we are doing work */
211         _lock.lock ();
212         
213         while (1) {
214                 for (list<ViewInterval>::iterator i = views.begin(); i != views.end(); ++i) {
215                         boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> ((*i).view->region());
216
217                         if (ar) {
218                                 i->intervals = ar->find_silence (dB_to_coefficient (threshold ()), minimum_length (), _interthread_info);
219                         }
220
221                         if (_interthread_info.cancel) {
222                                 break;
223                         }
224                 }
225
226                 if (!_interthread_info.cancel) {
227                         Completed (); /* EMIT SIGNAL */
228                 }
229
230                 /* Our work is done; sleep until there is more to do.
231                  * The lock is released while we are waiting.
232                  */
233                 _run_cond.wait (_lock);
234
235                 if (_thread_should_finish) {
236                         _lock.unlock ();
237                         return 0;
238                 }
239         }
240
241         return 0;
242 }
243
244 void
245 StripSilenceDialog::restart_thread ()
246 {
247         if (_destroying) {
248                 /* I don't know how this happens, but it seems to be possible for this
249                    method to be called after our destructor has finished executing.
250                    If this happens, bad things follow; _lock cannot be locked and
251                    Ardour hangs.  So if we are destroying, just bail early.
252                 */
253                 return;
254         }
255         
256         /* Cancel any current run */
257         _interthread_info.cancel = true;
258
259         /* Block until the thread waits() */
260         _lock.lock ();
261         /* Reset the flag */
262         _interthread_info.cancel = false;
263         _lock.unlock ();
264
265         /* And re-awake the thread */
266         _run_cond.signal ();
267 }
268
269 void
270 StripSilenceDialog::threshold_changed ()
271 {
272         update_threshold_line ();
273         restart_thread ();
274 }
275
276 framecnt_t
277 StripSilenceDialog::minimum_length () const
278 {
279         return _minimum_length.current_duration (views.front().view->region()->position());
280 }
281
282 framecnt_t
283 StripSilenceDialog::fade_length () const
284 {
285         return _minimum_length.current_duration (views.front().view->region()->position());
286 }
287                 
288 void
289 StripSilenceDialog::update_progress_gui (float p)
290 {
291         _progress_bar.set_fraction (p);
292 }