Make time stretch respect edit groups (#4615).
[ardour.git] / gtk2_ardour / editor_timefx.cc
1 /*
2     Copyright (C) 2000 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 #include <cstdlib>
22 #include <cmath>
23 #include <ctime>
24
25 #include <string>
26
27 #include "pbd/error.h"
28 #include "pbd/pthread_utils.h"
29 #include "pbd/memento_command.h"
30 #include "pbd/stateful_diff_command.h"
31
32 #include <gtkmm2ext/utils.h>
33
34 #include "audio_region_view.h"
35 #include "audio_time_axis.h"
36 #include "editor.h"
37 #include "region_selection.h"
38 #include "time_fx_dialog.h"
39
40 #include "ardour/session.h"
41 #include "ardour/region.h"
42 #include "ardour/audioplaylist.h"
43 #include "ardour/audio_track.h"
44 #include "ardour/audioregion.h"
45 #include "ardour/stretch.h"
46 #include "ardour/midi_stretch.h"
47 #include "ardour/pitch.h"
48
49 #ifdef USE_RUBBERBAND
50 #include "rubberband/RubberBandStretcher.h"
51 using namespace RubberBand;
52 #endif
53
54 #include "i18n.h"
55
56 using namespace std;
57 using namespace ARDOUR;
58 using namespace PBD;
59 using namespace Gtk;
60 using namespace Gtkmm2ext;
61
62 /** @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
63 int
64 Editor::time_stretch (RegionSelection& regions, float fraction)
65 {
66         // FIXME: kludge, implement stretching of selection of both types
67
68         if (regions.front()->region()->data_type() == DataType::AUDIO) {
69                 // Audio, pop up timefx dialog
70                 return time_fx (regions, fraction, false);
71         } else {
72                 // MIDI, just stretch
73                 RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (&regions.front()->get_time_axis_view());
74                 if (!rtv)
75                         return -1;
76
77                 boost::shared_ptr<Playlist> playlist = rtv->track()->playlist();
78
79                 ARDOUR::TimeFXRequest request;
80                 request.time_fraction = fraction;
81                 MidiStretch stretch(*_session, request);
82                 begin_reversible_command ("midi stretch");
83                 stretch.run(regions.front()->region());
84                 playlist->clear_changes ();
85                 playlist->replace_region (regions.front()->region(), stretch.results[0],
86                                 regions.front()->region()->position());
87                 _session->add_command (new StatefulDiffCommand (playlist));
88                 commit_reversible_command ();
89         }
90
91         return 0;
92 }
93
94 int
95 Editor::pitch_shift (RegionSelection& regions, float fraction)
96 {
97         return time_fx (regions, fraction, true);
98 }
99
100 /** @param val Percentage to time stretch by; ignored if pitch-shifting.
101  *  @param pitching true to pitch shift, false to time stretch.
102  *  @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
103 int
104 Editor::time_fx (RegionSelection& regions, float val, bool pitching)
105 {
106         delete current_timefx;
107
108         current_timefx = new TimeFXDialog (*this, pitching);
109
110         switch (current_timefx->run ()) {
111         case RESPONSE_ACCEPT:
112                 break;
113         default:
114                 current_timefx->hide ();
115                 return 1;
116         }
117
118         current_timefx->status = 0;
119         current_timefx->regions = regions;
120
121         if (pitching) {
122
123                 float cents = current_timefx->pitch_octave_adjustment.get_value() * 1200.0;
124                 float pitch_fraction;
125                 cents += current_timefx->pitch_semitone_adjustment.get_value() * 100.0;
126                 cents += current_timefx->pitch_cent_adjustment.get_value();
127
128                 if (cents == 0.0) {
129                         // user didn't change anything
130                         current_timefx->hide ();
131                         return 0;
132                 }
133
134                 // one octave == 1200 cents
135                 // adding one octave doubles the frequency
136                 // ratio is 2^^octaves
137
138                 pitch_fraction = pow(2, cents/1200);
139
140                 current_timefx->request.time_fraction = 1.0;
141                 current_timefx->request.pitch_fraction = pitch_fraction;
142
143         } else {
144
145                 current_timefx->request.time_fraction = val;
146                 current_timefx->request.pitch_fraction = 1.0;
147
148         }
149
150 #ifdef USE_RUBBERBAND
151         /* parse options */
152
153         RubberBandStretcher::Options options = 0;
154
155         bool realtime = false;
156         bool precise = false;
157         bool peaklock = true;
158         bool longwin = false;
159         bool shortwin = false;
160         bool preserve_formants = false;
161         string txt;
162
163         enum {
164                 NoTransients,
165                 BandLimitedTransients,
166                 Transients
167         } transients = Transients;
168
169         precise = current_timefx->precise_button.get_active();
170         preserve_formants = current_timefx->preserve_formants_button.get_active();
171
172         txt = current_timefx->stretch_opts_selector.get_active_text ();
173
174         for (int i = 0; i <= 6; i++) {
175                 if (txt == rb_opt_strings[i]) {
176                         rb_current_opt = i;
177                         break;
178                 }
179         }
180
181         switch (rb_current_opt) {
182                 case 0:
183                         transients = NoTransients; peaklock = false; longwin = true; shortwin = false;
184                         break;
185                 case 1:
186                         transients = NoTransients; peaklock = false; longwin = false; shortwin = false;
187                         break;
188                 case 2:
189                         transients = NoTransients; peaklock = true; longwin = false; shortwin = false;
190                         break;
191                 case 3:
192                         transients = BandLimitedTransients; peaklock = true; longwin = false; shortwin = false;
193                         break;
194                 case 5:
195                         transients = Transients; peaklock = false; longwin = false; shortwin = true;
196                         break;
197                 case 6:
198                         transients = NoTransients;
199                         precise = true;
200                         preserve_formants = false;
201                         current_timefx->request.pitch_fraction = 1/val;
202                         shortwin = true;
203                         // peaklock = false;
204                         break;
205                 default:
206                         /* default/4 */
207                         transients = Transients; peaklock = true; longwin = false; shortwin = false;
208                         break;
209         };
210
211         if (realtime)          options |= RubberBandStretcher::OptionProcessRealTime;
212         if (precise)           options |= RubberBandStretcher::OptionStretchPrecise;
213         if (preserve_formants) options |= RubberBandStretcher::OptionFormantPreserved;
214         if (!peaklock)         options |= RubberBandStretcher::OptionPhaseIndependent;
215         if (longwin)           options |= RubberBandStretcher::OptionWindowLong;
216         if (shortwin)          options |= RubberBandStretcher::OptionWindowShort;
217
218         switch (transients) {
219         case NoTransients:
220                 options |= RubberBandStretcher::OptionTransientsSmooth;
221                 break;
222         case BandLimitedTransients:
223                 options |= RubberBandStretcher::OptionTransientsMixed;
224                 break;
225         case Transients:
226                 options |= RubberBandStretcher::OptionTransientsCrisp;
227                 break;
228         }
229
230         current_timefx->request.opts = (int) options;
231 #else
232         current_timefx->request.quick_seek = current_timefx->quick_button.get_active();
233         current_timefx->request.antialias = !current_timefx->antialias_button.get_active();
234 #endif
235         current_timefx->request.done = false;
236         current_timefx->request.cancel = false;
237
238         /* re-connect the cancel button and delete events */
239
240         current_timefx->first_cancel.disconnect();
241         current_timefx->first_delete.disconnect();
242
243         current_timefx->first_cancel = current_timefx->cancel_button->signal_clicked().connect
244                 (sigc::mem_fun (current_timefx, &TimeFXDialog::cancel_in_progress));
245         current_timefx->first_delete = current_timefx->signal_delete_event().connect
246                 (sigc::mem_fun (current_timefx, &TimeFXDialog::delete_in_progress));
247
248         if (pthread_create_and_store ("timefx", &current_timefx->request.thread, timefx_thread, current_timefx)) {
249                 current_timefx->hide ();
250                 error << _("timefx cannot be started - thread creation error") << endmsg;
251                 return -1;
252         }
253
254         pthread_detach (current_timefx->request.thread);
255
256         while (!current_timefx->request.done && !current_timefx->request.cancel) {
257                 gtk_main_iteration ();
258         }
259
260         current_timefx->hide ();
261         return current_timefx->status;
262 }
263
264 void
265 Editor::do_timefx (TimeFXDialog& dialog)
266 {
267         Track*    t;
268         boost::shared_ptr<Playlist> playlist;
269         boost::shared_ptr<Region>   new_region;
270         bool in_command = false;
271
272         uint32_t const N = dialog.regions.size ();
273
274         for (RegionSelection::iterator i = dialog.regions.begin(); i != dialog.regions.end(); ) {
275                 AudioRegionView* arv = dynamic_cast<AudioRegionView*>(*i);
276
277                 if (!arv) {
278                         continue;
279                 }
280
281                 boost::shared_ptr<AudioRegion> region (arv->audio_region());
282                 TimeAxisView* tv = &(arv->get_time_axis_view());
283                 RouteTimeAxisView* rtv;
284                 RegionSelection::iterator tmp;
285
286                 tmp = i;
287                 ++tmp;
288
289                 if ((rtv = dynamic_cast<RouteTimeAxisView*> (tv)) == 0) {
290                         i = tmp;
291                         continue;
292                 }
293
294                 if ((t = dynamic_cast<Track*> (rtv->route().get())) == 0) {
295                         i = tmp;
296                         continue;
297                 }
298
299                 if ((playlist = t->playlist()) == 0) {
300                         i = tmp;
301                         continue;
302                 }
303
304                 if (dialog.request.cancel) {
305                         /* we were cancelled */
306                         dialog.status = 1;
307                         return;
308                 }
309
310                 Filter* fx;
311
312                 if (dialog.pitching) {
313                         fx = new Pitch (*_session, dialog.request);
314                 } else {
315 #ifdef USE_RUBBERBAND
316                         fx = new RBStretch (*_session, dialog.request);
317 #else
318                         fx = new STStretch (*_session, dialog.request);
319 #endif
320                 }
321
322                 current_timefx->descend (1.0 / N);
323
324                 if (fx->run (region, current_timefx)) {
325                         dialog.status = -1;
326                         dialog.request.done = true;
327                         delete fx;
328                         return;
329                 }
330
331                 if (!fx->results.empty()) {
332                         new_region = fx->results.front();
333
334                         if (!in_command) {
335                                 _session->begin_reversible_command (dialog.pitching ? _("pitch shift") : _("time stretch"));
336                                 in_command = true;
337                         }
338
339                         playlist->clear_changes ();
340                         playlist->replace_region (region, new_region, region->position());
341                         _session->add_command (new StatefulDiffCommand (playlist));
342                 }
343
344                 current_timefx->ascend ();
345
346                 i = tmp;
347                 delete fx;
348         }
349
350         if (in_command) {
351                 _session->commit_reversible_command ();
352         }
353
354         dialog.status = 0;
355         dialog.request.done = true;
356 }
357
358 void*
359 Editor::timefx_thread (void *arg)
360 {
361         SessionEvent::create_per_thread_pool ("timefx events", 64);
362
363         TimeFXDialog* tsd = static_cast<TimeFXDialog*>(arg);
364
365         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
366
367         tsd->editor.do_timefx (*tsd);
368
369         /* GACK! HACK! sleep for a bit so that our request buffer for the GUI
370            event loop doesn't die before any changes we made are processed
371            by the GUI ...
372         */
373
374         struct timespec t = { 2, 0 };
375         nanosleep (&t, 0);
376
377         return 0;
378 }
379